From cc4a2eda79cdc50c121520151910531ae1aaf8ef Mon Sep 17 00:00:00 2001 From: shitpostalotl Date: Tue, 2 Aug 2022 18:55:31 -0700 Subject: [PATCH] edit readme --- README.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 06b1dfb7..07e50b1a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,18 @@ # Pleroma-FE -This is a fork of Pleroma-FE from the Pleroma project, with support for new Akkoma features such as: -- MFM support via [marked-mfm](https://akkoma.dev/sfr/marked-mfm) -- Custom emoji reactions +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. # For Translators -The [Weblate UI](https://translate.akkoma.dev/projects/akkoma/pleroma-fe/) is recommended for adding or modifying translations for Pleroma-FE. - -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. +Please put translations in the real Akkoma-FE repo. ## Build Setup ``` bash +# enter dev shell +nix-shell -p nodejs nodePackages.npm yarn + # install dependencies -npm install -g yarn yarn # serve with hot reload at localhost:8080