From b23079826670b6c301d78a2bf967aabeff18cb15 Mon Sep 17 00:00:00 2001
From: everest <liamwaldron7009@protonmail.com>
Date: Thu, 10 Mar 2022 13:52:05 +0000
Subject: [PATCH] Create glacier.md

---
 docs/glacier.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 docs/glacier.md

diff --git a/docs/glacier.md b/docs/glacier.md
new file mode 100644
index 0000000..53c2436
--- /dev/null
+++ b/docs/glacier.md
@@ -0,0 +1,24 @@
+Glacier is a simple package manager written in Shell.
+
+It uses wget as a backend to fetch tarballs from the package repository.
+
+It saves package information files to /etc/glacier/pkginfo
+
+### Packaging
+
+Packages should be formatted as `tar.gz` archives, and should contain the following:
+
+- The package's executable
+- 3 instruction scripts written in Shell, INSTALL.sh, UPDATE.sh, and REMOVE.sh
+- package_name-pkginfo.json, containing the following:
+```
+{
+    "package_name": "NAME HERE",
+    "package_version": "VERSION HERE",
+    "package_description": "DESCRIPTION HERE",
+    "src_tree_size": "SIZE OF SOURCE TREE HERE",
+    "exec_size": "EXECUTABLE SIZE HERE",
+    "license": "LICENSE NAME HERE",
+}
+```
+All packages should be uploaded to https://github.com/everest-linux/glacier-pkgs by adding the package tarball to the pkgs folder, and submitting a pull request.