path: root/README.md
diff options
Diffstat (limited to 'README.md')
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d3fc434
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+Package manager for Carbs Linux. Forked from [KISS]. All
+usage information can be obtained from the manual page.
+For changes please refer to the `CHANGELOG.md` file.
+[KISS]: https://github.com/kisslinux/kiss
+## Fork Notes
+There are certain differences between KISS Linux `kiss` and
+Carbs Linux `kiss`. Most importantly, you need a C compiler
+and a C library (musl/bsd libc) to build this implementation
+of it. Rest of the important changes can be found in the CHANGELOG.
+This is _mostly_ a shell implementation rather than a pure one.
+### Directory Structure
+ / -- kiss, README, Makefile, LICENSE, CHANGELOG
+ bin/ -- for C programs.
+ man/ -- for manual pages / documentation.
+ contrib/ -- for Shell scripts that wrap around kiss.