diff options
| author | Gabriel A. Giovanini <mail@gabrielgio.me> | 2025-02-15 22:14:12 +0100 |
|---|---|---|
| committer | Gabriel A. Giovanini <mail@gabrielgio.me> | 2025-02-15 22:14:12 +0100 |
| commit | f4ea96c52928eedd11b3f809cd9a481eda214482 (patch) | |
| tree | 996855cd642bf84bbf65a74b40eeb4a6d48eb16d | |
| parent | 5845a8685b1696cd510a3362d1f174568d3a9221 (diff) | |
| download | cerrado-f4ea96c52928eedd11b3f809cd9a481eda214482.tar.gz cerrado-f4ea96c52928eedd11b3f809cd9a481eda214482.tar.bz2 cerrado-f4ea96c52928eedd11b3f809cd9a481eda214482.zip | |
docs: Update goals
Makes clear what is needed for 1.0, also pushs mail based PR for the
feature.
| -rw-r--r-- | README.md | 21 |
1 files changed, 12 insertions, 9 deletions
@@ -1,6 +1,6 @@ ### Cerrado -Self host single user mail based forge. +Self host single user forge. You can find a running instance here: @@ -21,9 +21,9 @@ 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. +including its statics files, is bundled into a single binary. -To run the project you just need to do a make run. +To run the project you just need to `make run`. ### Installations @@ -61,18 +61,21 @@ mail@gabrielgio.me ### Missing for 1.0 -- Git clone support -- Some rework on summary page. +- Git clone support: that is very important feature for a git forge. +- Dark mode support: in the same way as mobile support this should be supported + from the get go. I have slacked on this one but it should be done before 1.0. +- Some rework on summary page: it is feels a bit crude as it is. ### Ideas -- Mail patch / mailing list - Code snippet support - Setup manual (man feature perhaps?) -- Add authentication - - Enforce public property - Add metrics - Add reference based cache system. Cerrado should be able to cache the whole - page based on its reference hash. + page based on its reference hash + +### Future +- Mail patch / mailing list. This is very complex endeavour. In a distant + future I might do it, but for now I will focus on the features listed above. [^1]: https://git.sr.ht/~emersion/scfg [^2]: https://apkdoc.gabrielgio.me/ |