X-Git-Url: http://git.squeep.com/?a=blobdiff_plain;f=README.md;h=bf56cb81712e23e8e6568ff1c2410d29405db278;hb=c301a95276fd1e66208a9f6ccdcf5e29f0be51e1;hp=6ca3118fbeaea91c39352dc0d9f73346317f58d3;hpb=59bdef0c337f1892282e245c5a236680af8e0318;p=akkoma
diff --git a/README.md b/README.md
index 6ca3118fb..bf56cb817 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,64 @@
+## akkoma
+
+*a smallish microblogging platform, aka the cooler pleroma*
+
+### Why though?
+
+pleroma as a project has stagnated of late. after a spat between
+developers led to a fork (which died due to chronic lack of direction),
+nearly nobody seems to _want_ to work on it. this in addition to the
+BDFL being AWOL whenever needed, means that the entire project is
+nought but a power vacuum waiting for someone to step in. and with the
+track record pleroma has, i do not trust that whoever steps in will be
+good for the project.
+
+thus, i am striking out on my own. i already had a few modifications
+on my instance, so it wasn't a particularly large leap to assume direct
+control.
+
+### But really, why should I migrate to your thing?
+
+aside from me actually being responsive? let's lookie here, we've got
+- custom emoji reactions
+- misskey markdown (MFM) rendering and posting support
+- elasticsearch support (because pleroma search is GARBAGE)
+- latest develop pleroma-fe additions
+- local-only posting
+- probably more, this is like 3.5 years of IHBA additions finally compiled
+
+## Upgrading to Akkoma
+
+### From source
+
+```bash
+git remote set-url origin https://akkoma.dev/AkkomaGang/akkoma.git/
+git fetch origin
+git pull -r
+```
+
+Then compile, migrate and restart as usual.
+
+Then if you've done anything fancy to the frontend, you'll want to get the
+updates for that as well. This won't be the same for any two instances,
+so `https://akkoma.dev/AkkomaGang/pleroma-fe` is the repo you need.
+
+### From OTP
+
+```bash
+export FLAVOUR=$(arch="$(uname -m)";if [ "$arch" = "x86_64" ];then arch="amd64";elif [ "$arch" = "armv7l" ];then arch="arm";elif [ "$arch" = "aarch64" ];then arch="arm64";else echo "Unsupported arch: $arch">&2;fi;if getconf GNU_LIBC_VERSION>/dev/null;then libc_postfix="";elif [ "$(ldd 2>&1|head -c 9)" = "musl libc" ];then libc_postfix="-musl";elif [ "$(find /lib/libc.musl*|wc -l)" ];then libc_postfix="-musl";else echo "Unsupported libc">&2;fi;echo "$arch$libc_postfix")
+
+./bin/pleroma_ctl update --zip-url https://akkoma-updates.s3-website.fr-par.scw.cloud/develop/akkoma-$FLAVOUR.zip
+./bin/pleroma_ctl migrate
+```
+
+Then restart. When updating in the future, can just use
+
+```bash
+./bin/pleroma_ctl update --branch develop
+```
+
+### Old readme follows
+
## About
@@ -18,22 +79,26 @@ If you are running Linux (glibc or musl) on x86/arm, the recommended way to inst
### From Source
If your platform is not supported, or you just want to be able to edit the source code easily, you may install Pleroma from source.
-- [Debian-based](https://docs-develop.pleroma.social/backend/installation/debian_based_en/)
-- [Debian-based (jp)](https://docs-develop.pleroma.social/backend/installation/debian_based_jp/)
- [Alpine Linux](https://docs-develop.pleroma.social/backend/installation/alpine_linux_en/)
- [Arch Linux](https://docs-develop.pleroma.social/backend/installation/arch_linux_en/)
+- [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
+- [Debian-based](https://docs-develop.pleroma.social/backend/installation/debian_based_en/)
+- [Debian-based (jp)](https://docs-develop.pleroma.social/backend/installation/debian_based_jp/)
+- [FreeBSD](https://docs-develop.pleroma.social/backend/installation/freebsd_en/)
- [Gentoo Linux](https://docs-develop.pleroma.social/backend/installation/gentoo_en/)
- [NetBSD](https://docs-develop.pleroma.social/backend/installation/netbsd_en/)
- [OpenBSD](https://docs-develop.pleroma.social/backend/installation/openbsd_en/)
- [OpenBSD (fi)](https://docs-develop.pleroma.social/backend/installation/openbsd_fi/)
-- [CentOS 7](https://docs-develop.pleroma.social/backend/installation/centos7_en/)
### OS/Distro packages
-Currently Pleroma is not packaged by any OS/Distros, but if you want to package it for one, we can guide you through the process on our [community channels](#community-channels). If you want to change default options in your Pleroma package, please **discuss it with us first**.
+Currently Pleroma is packaged for [YunoHost](https://yunohost.org). If you want to package Pleroma for any OS/Distros, we can guide you through the process on our [community channels](#community-channels). If you want to change default options in your Pleroma package, please **discuss it with us first**.
### Docker
While we donât provide docker files, other people have written very good ones. Take a look at or .
+### Raspberry Pi
+Community maintained Raspberry Pi image that you can flash and run Pleroma on your Raspberry Pi. Available here .
+
### Compilation Troubleshooting
If you ever encounter compilation issues during the updating of Pleroma, you can try these commands and see if they fix things:
@@ -49,5 +114,5 @@ If you are not developing Pleroma, it is better to use the OTP release, which co
- Latest Git revision:
## Community Channels
-* IRC: **#pleroma** and **#pleroma-dev** on freenode, webchat is available at
-* Matrix: and
+* IRC: **#pleroma** and **#pleroma-dev** on libera.chat, webchat is available at
+* Matrix: [#pleroma:libera.chat](https://matrix.to/#/#pleroma:libera.chat) and [#pleroma-dev:libera.chat](https://matrix.to/#/#pleroma-dev:libera.chat)