Working as of 12/11

README

@@ -0,0 +1,51 @@
++ libglacier-ng
+
+Backend APIs for the Glacier package manager
+
++ Modularity
+
+Libglacier-ng is, by default, incredibly modular. The default featureset is very
+minimal, but modules are available for installtion. These modules allow for features
+such as HTML reports, remote package deployment, and more. Keep in mind that the
+more features you have installed, the larger the attack surface is. The default
+featureset should be sufficient for 99% of users.
+
++ Installation
+
+Libglacier-ng is provided by default as multiple shared object files (.so).
+Static compilation at this time is not possible because glacier-ng, which is primarily
+written in Lua, requires shared objects.
+
+Libglacier-ng depends on the following libraries:
+
+	~ libconfig
+
+Once these dependencies are installed, clone this repository:
+
+	+---------------------------------------------------------------------+
+	| $ git clone https://git.everestlinux.org/EverestLinux/libglacier-ng |
+	+---------------------------------------------------------------------+
+
+Enter the directory and make any desired modifications to config.mk:
+
+	+----------------------------------------------+
+	| $ cd libglacier                              |
+	| $ EDITOR="/bin/vim" # or your desired editor |
+	| $ ${EDITOR} config.mk                        |
+	+----------------------------------------------+
+
+Build and install the library:
+
+	+-----------------+
+	| $ make $(nproc) |
+	| # make install  |
+	+-----------------+
+
++ Documentation
+
+Online documentation can be accessed at https://www.everestlinux.org/docs/libglacier
+Offline documentationn can be accessed with the following command:
+
+	+--------------------+
+	| $ man 3 libglacier |
+	+--------------------+