forked from AkkomaGang/akkoma-fe
edit readme
This commit is contained in:
parent
a4c9f05808
commit
cc4a2eda79
1 changed files with 5 additions and 13 deletions
18
README.md
18
README.md
|
@ -1,26 +1,18 @@
|
||||||
# Pleroma-FE
|
# Pleroma-FE
|
||||||
|
|
||||||
This is a fork of Pleroma-FE from the Pleroma project, with support for new Akkoma features such as:
|
This is a fork of Akkoma-FE from the Akkoma project, with what I think is a better UI for mobile devices and things of that nature.
|
||||||
- MFM support via [marked-mfm](https://akkoma.dev/sfr/marked-mfm)
|
|
||||||
- Custom emoji reactions
|
|
||||||
|
|
||||||
# For Translators
|
# For Translators
|
||||||
|
|
||||||
The [Weblate UI](https://translate.akkoma.dev/projects/akkoma/pleroma-fe/) is recommended for adding or modifying translations for Pleroma-FE.
|
Please put translations in the real Akkoma-FE repo.
|
||||||
|
|
||||||
Alternatively, edit/create `src/i18n/$LANGUAGE_CODE.json` (where `$LANGUAGE_CODE` is the [ISO 639-1 code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language), then add your language to [src/i18n/messages.js](https://akkoma.dev/AkkomaGang/pleroma-fe/src/branch/develop/src/i18n/messages.js) if it doesn't already exist there.
|
|
||||||
|
|
||||||
Pleroma-FE will set your language by your browser locale, but you can temporarily force it in the code by changing the locale in main.js.
|
|
||||||
|
|
||||||
# FOR ADMINS
|
|
||||||
|
|
||||||
To use Pleroma-FE in Akkoma, use the [frontend](https://docs.akkoma.dev/stable/administration/CLI_tasks/frontend/) CLI task to install Pleroma-FE, then modify your configuration as described in the [Frontend Management](https://docs.akkoma.dev/stable/configuration/frontend_management/) doc.
|
|
||||||
|
|
||||||
## Build Setup
|
## Build Setup
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
|
# enter dev shell
|
||||||
|
nix-shell -p nodejs nodePackages.npm yarn
|
||||||
|
|
||||||
# install dependencies
|
# install dependencies
|
||||||
npm install -g yarn
|
|
||||||
yarn
|
yarn
|
||||||
|
|
||||||
# serve with hot reload at localhost:8080
|
# serve with hot reload at localhost:8080
|
||||||
|
|
Loading…
Reference in a new issue