34 lines
1.4 KiB
Markdown
34 lines
1.4 KiB
Markdown
# Akkoma: Whimsical Forest Edition
|
||
|
||
This is [upstream Akkoma `develop`](https://akkoma.dev/AkkomaGang/akkoma/src/branch/develop)
|
||
with some additional patches for testing.
|
||
|
||
All patches (sans the initial wf-ifying one) are intended to reach upstream
|
||
eventually and either already have an upstream PR or are intended to be turned
|
||
into one once they’ve passed initial testing and became more stable.
|
||
|
||
See `patches/series` for a list of applied changes.
|
||
Patch names beginning with `pr111_` indicate it’s copied from upstream PR `#111`;
|
||
`wip_` is used for patches not yet ready for an upstream PR.
|
||
|
||
## Usage
|
||
|
||
You’re free to use this for your own instance but keep in mind some of those
|
||
patches are experimental and might not yet have been merged for a good reason.
|
||
Thus you should only do this if you’re comfortable with doing beta testing and
|
||
capable of debugging upcoming issues on your own far enought to figure out
|
||
which patch introduces the problem and create a useful, detailed report for
|
||
the corresponding upstream PR.
|
||
If a patch changes its database scheme prior to being merged upstream,
|
||
some manual DB fixups might be needed.
|
||
|
||
|
||
If you still want to, just clone this repo and run:
|
||
|
||
```sh
|
||
MIX_ENV=prod make build
|
||
```
|
||
|
||
to build patched Akkoma WF Edition inside the `akkoma/` subdir.
|
||
You can then continue to use Akkoma from within this subdir as usual.
|
||
To upgrade to a new version, just repeat the above command.
|