diff --git a/README b/README new file mode 100644 index 0000000..d58d6e0 --- /dev/null +++ b/README @@ -0,0 +1,70 @@ ++-----+ +| esm | ++-----+ + +Esm is a bootscript manager for Linux. It interfaces with SysVinit-style bootscripts. + ++--------------+ +| Installation | ++--------------+ + +Esm requires the following libraries to compile: + + * libconfig + +Libconfig is provided as a submodule of esm's source tree. +Clone and enter the repository: + + $ git clone https://git.everestlinux.org/EverestLinux/esm + $ cd esm + +If you wish to compile the provided libconfig, follow the steps below: + + Update the submodule: + $ git submodule update --init --recursive + + Change directory into libconfig: + $ cd src/libconfig + + Generate the necessary build files: + $ autoreconf + + Run the configure script and compile the library: + $ ./configure && make + + (OPTIONAL) Run the test suite: + $ make check + + Install the library: + # make install + +Otherwise, compile the esm binary: + + $ make + +Install esm: + + # make install + ++-----------+ +| COPYRIGHT | ++-----------+ + +Esm uses the following third-party libraries: +* Libcobnfig - Licensed under the LGPL v2.1. + The source code for libconfig is available at: + The full text for the LGPOL v2.1 is available at: + +(C) 2025 Everest Developers +This program is free software: you can redistribute it and/or modify it +under the terms of the GNU General Public License as published by the +Free Software Foundation, either version 3 of the License, or (at your option) +any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. +See the GNU General Public License for more details. +You should have received a copy of the GNU General Public License along with +this program. +If not, see .