From b2623086674b3954b4be8f09e7d3c9e67b4522e3 Mon Sep 17 00:00:00 2001 From: Otto Date: Thu, 17 Nov 2022 21:26:03 +0000 Subject: [PATCH] README draft with skeleton --- README.md | 63 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 63 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000000..218081a36a --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Welcome to Forgejo + +Hi there! Tired of big platforms playing monopoly? +Providing Git hosting for your project, friends, company or community? +Forgejo (Esperanto: forge) has you covered with it's intuitive interface, +light and easy hosting and a lot of builtin functionality. + +Forgejo was forked from the well-known [Gitea](https://gitea.io) project in 2022, +because we think that the project should be owned by an independent community instead of a for-profit company. +If you second that, then Forgejo is for you! +Our promise: Independent Free/Libre Software forever! + + +## What does Forgejo offer? + +If you want to know what Forgejo is like, +you can check out public instances, +e.g. [Codeberg.org](https://codeberg.org). + +If you like any of the following, Forgejo is literally meant for you: + +- Lightweight: Forgejo can easily be hosted on nearly **every machine**. + Running on a Raspberry? Small cloud instance? No problem! +- Intuitive: We aim for a user experience that is **friendly** to newcomers and **productive** for power users. +- Project management: Next to Git hosting, Forgejo offers issues, + pull requests, wikis, kanban boards and much more to **coordinate with your team**. +- Publishing: Have something to share? Use **releases** to host your software for download, + or use the **package registry** to publish it for docker, npm and many other package managers. +- Customizable: Want to change your look? Change some settings? + There are many **config switches** to make Forgejo work exactly like you want. +- Powerful: Organizations & team permissions, CI integration, Code Search, LDAP, OAuth and much more. + If you have **advanced needs**, Forgejo has you covered. +- Federation: (WIP) We are actively working to connect software forges with each other through **ActivityPub**, + and create a collaborative network of personal instances. + Interested? [Read more below](#Status-of-federation) + + +## Getting started + +We're working towards our first release. +The download options will be published here. + +### Documentation + +... + +## Roadmap + +We're currently working on ... for the next release. + + +### Status of Federation + +... + + +## Contributing + +... + +### Translating + +## Thanks to ... \ No newline at end of file