aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel A. Giovanini <mail@gabrielgio.me>2024-06-25 21:12:25 +0200
committerGabriel A. Giovanini <mail@gabrielgio.me>2024-06-25 21:19:56 +0200
commit8f9853c8e26ffbad74e6414cec31104281a3860b (patch)
tree98bb036edd705dcd75e9c0981b5b124352adf6b0 /README.md
parent259cea1f3ec50f1db117ffe651ee9b2e8e0740a5 (diff)
downloadcerrado-8f9853c8e26ffbad74e6414cec31104281a3860b.tar.gz
cerrado-8f9853c8e26ffbad74e6414cec31104281a3860b.tar.bz2
cerrado-8f9853c8e26ffbad74e6414cec31104281a3860b.zip
chore: Update readme and add LICENSE
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 41 insertions, 2 deletions
diff --git a/README.md b/README.md
index fd92d5c..e49e6bc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
-# Cerrado
+### Cerrado
-Self single user mail based forge for git.
+Self host single user mail based forge.
+
+### Goals
+
+Keep it simple and lightweight, that includes the application itself,
+development process and the deployment.
+
+The application requires no javascript to run, and it is light and fast to
+render.
+
+This project is also easy to iterate on. There are only two dev dependencies: go
+and sassc so it compiles fast. Codewise it strives for easy to understand.
+Easy to read code is better than clever.
+
+The deployment process should be easy to wrap the head around and
+straightforward to set up. To achieve that it uses a simple file format[^1] to
+configure everything. Also to reduce the moving parts the whole application,
+including its statics file, is bundled into a single binary.
+
+To run the project you just need to do a make run.
+
+### TODO
+
+- Add path to tree view
+ - Fix href with extra slash
+- Add message to tags
+- Add link to tar browser from commit page
+- Add patch to the commit page
+- Add log pagination
+- Add tag pagination
+
+### Milestone
+- Mail patch / mailing list
+- Code snippet support
+- Setup manual (man feature perhaps?)
+- Add authentication
+ - Enforce public property
+- Add metrics
+
+[^1]: https://git.sr.ht/~emersion/scfg