Add fork info to README #4

Merged
Minecon724 merged 3 commits from readme into forgejo 2025-06-04 21:03:47 +02:00
2 changed files with 71 additions and 1 deletions

View file

@ -5,3 +5,69 @@ The Forgejo project is run by a community of people who are expected to follow t
Sensitive security-related issues should be reported to [security@forgejo.org](mailto:security@forgejo.org) using [encryption](https://keyoxide.org/security@forgejo.org).
You can find links to the different aspects of Developer documentation on this page: [Forgejo Contributor Guide](https://forgejo.org/docs/next/contributor/).
## For developers
Consider the below an appendix to the valuable [official *Forgejo Contributor Guide*](https://forgejo.org/docs/next/contributor).
For any development work, it's recommended to use the devcontainer.
### Building
Build a single image for multiple architectures:
1. Setup: (do this once)
```bash
docker buildx create --name mybuilder --use
docker buildx inspect --bootstrap
docker run --privileged --rm tonistiigi/binfmt --install all
```
2. Build:
```bash
docker buildx build --platform linux/amd64,linux/arm64 -t user/repo:tag --push .
```
Replace the tag. You can add more architectures, if you wish.
For non-Docker builds, [use the official instructions](https://forgejo.org/docs/next/contributor/from-source/).
### Live reload
Live reload make it easy to view changes.
```bash
TAGS='sqlite sqlite_unlock_notify' make watch
```
It's still recommended to restart whenever it's convenient, or making a bigger change.
### Merge
Merging changes from vanilla.
Make sure you checked out the branch to merge to.
1. Add the upstream repository, if you haven't already:
```bash
git remote add upstream https://codeberg.org/forgejo/forgejo.git
```
2. Fetch changes: (note: `--no-tags` is necessary)
```bash
git fetch --no-tags upstream
```
3. Merge the changes into the fork:
```bash
git merge upstream/$BRANCH
```
### Tag a release
```
git tag $TAG
git push origin tag $TAG
```

View file

@ -31,7 +31,11 @@ If you like any of the following, Forgejo is literally meant for you:
- Federation: (WIP) We are actively working to connect software forges with each other through **ActivityPub**,
and create a collaborative network of personal instances.
## Learn more
## What does this fork offer over vanilla Forgejo?
Features are now tracked by Pull Requests, [see those here](https://git.m724.eu/git724/forgejo/pulls).
## Learn more about Forgejo
Dive into the [documentation](https://forgejo.org/docs/latest/), subscribe to releases and blog post on [our website](https://forgejo.org), <a href="https://floss.social/@forgejo" rel="me">find us on the Fediverse</a> or hop into [our Matrix room](https://matrix.to/#/#forgejo-chat:matrix.org) if you have any questions or want to get involved.