diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 41 insertions, 2 deletions
@@ -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 |