aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--README.md60
1 files changed, 52 insertions, 8 deletions
diff --git a/README.md b/README.md
index e5493e2..94442dd 100644
--- a/README.md
+++ b/README.md
@@ -2,13 +2,57 @@
**Work in progress.**
-This is the new implementation in the [Hare](https://harelang.org) programming
-language.
+Lindenii Forge aims to be an uncomplicated yet featured software forge,
+primarily designed for self-hosting by small organizations and individuals.
-## Architecture
+* [Upstream source repository](https://forge.lindenii.runxiyu.org/forge/-/repos/server/)
+ ([backup](https://git.lindenii.runxiyu.org/forge.git/))
+* [Website and documentation](https://lindenii.runxiyu.org/forge/)
+* [Temporary issue tracker](https://todo.sr.ht/~runxiyu/forge)
+* IRC [`#lindenii`](https://webirc.runxiyu.org/kiwiirc/#lindenii)
+ on [irc.runxiyu.org](https://irc.runxiyu.org)\
+ and [`#lindenii`](https://web.libera.chat/#lindenii)
+ on [Libera.Chat](https://libera.chat)
-* Most components are one single daemon written in Hare.
-* Because libssh is difficult to use and there aren't many other SSH server
- libraries for C or Hare, we will temporarily use
- [the gliberlabs SSH library for Go](https://github.com/gliderlabs/ssh)
- in a separate process, and communicate via UNIX domain sockets.
+## Implemented features
+
+* Umambiguously parsable URL
+* Groups and subgroups
+* Repo hosting
+* Push to `contrib/` branches to automatically create merge requests
+* Basic federated authentication
+* Converting mailed patches to branches
+
+## Planned features
+
+* Further Integration with mailing list workflows
+* Ticket trackers and discussions
+ * Web interface
+ * Email integration with IMAP archives
+* SSH API
+* Email access
+
+## License
+
+We are currently using the
+[GNU Affero General Public License version 3](https://www.gnu.org/licenses/agpl-3.0.html).
+
+The forge software serves its own source at `/-/source/`.
+
+## Contribute
+
+Please submit patches by pushing to `contrib/...` in the official repo.
+
+Alternatively, send email to
+[`forge/-/repos/server@forge.lindenii.runxiyu.org`](mailto:forge%2F-%2Frepos%2Fserver@forge.lindenii.runxiyu.org).
+Note that emailing patches is still experimental.
+
+## Mirrors
+
+We have several repo mirrors:
+
+* [Official repo on our own instance of Lindenii Forge](https://forge.lindenii.runxiyu.org/forge/-/repos/server/)
+* [The Lindenii Project's backup cgit](https://git.lindenii.runxiyu.org/forge.git/)
+* [SourceHut](https://git.sr.ht/~runxiyu/forge/)
+* [Codeberg](https://codeberg.org/lindenii/forge/)
+* [GitHub](https://github.com/runxiyu/forge/)