From a862dc74de40de92011cb12816e9b5a348f77201 Mon Sep 17 00:00:00 2001 From: Bob Mottram Date: Thu, 29 Aug 2019 11:23:58 +0000 Subject: [PATCH] Separate customizations information --- README.md | 16 ++-------------- README_customizations.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 README_customizations.md diff --git a/README.md b/README.md index 909c03d1b..54dad746a 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,8 @@ Includes emojis designed by [OpenMoji](https://openmoji.org) – the open-source [Project Goals](README_goals.md) +[Customizations](README_customizations.md) + ## Install On Arch/Parabola: @@ -85,17 +87,3 @@ If you are the account holder though you will be able to see exactly who you're A description of the proposed object capabilities model [is here](ocaps.md). -## Customizations - -You can customize the terms of service by editing **accounts/tos.txt**. If it doesn't already exist then you can use **default_tos.txt** as a template. - -On the login screen you can provide a custom welcome message by creating the file **accounts/login.txt**. This could be used to show a motd or scheduled maintenance information. - -You can customize the image on the login screen by saving your instance logo to **accounts/login.png**. A background image can also be set for the login screen by adding **accounts/login-background.png** - -A custom background image can be supplied for the search screen by adding **accounts/search-background.png** - -When a moderator report is created the message at the top of the screen can be customized to provide any additional information, advice or alerts. Edit **accounts/report.txt** and add your text. - -Extra emoji can be added to the *emoji* directory and you should then update the **emoji/emoji.json** file, which maps the name to the filename (without the .png extension). - diff --git a/README_customizations.md b/README_customizations.md new file mode 100644 index 000000000..6ea9a47f2 --- /dev/null +++ b/README_customizations.md @@ -0,0 +1,28 @@ +# Epicyon Customizations + +## Terms of Service + +You can customize the terms of service by editing **accounts/tos.txt**. If it doesn't already exist then you can use **default_tos.txt** as a template. + +## About Your Instance + +Information about your instance and its origin story can be added by editing **accounts/about.txt**. + +## Welcome Message + +On the login screen you can provide a custom welcome message by creating the file **accounts/login.txt**. This could be used to show a motd or scheduled maintenance information. + +## Login Logo + +You can customize the image on the login screen by saving your instance logo to **accounts/login.png**. A background image can also be set for the login screen by adding **accounts/login-background.png** + +A custom background image can be supplied for the search screen by adding **accounts/search-background.png** + +## Reports Advice + +When a moderator report is created the message at the top of the screen can be customized to provide any additional information, advice or alerts. Edit **accounts/report.txt** and add your text. + +## Extra Emoji + +Extra emoji can be added to the *emoji* directory and you should then update the **emoji/emoji.json** file, which maps the name to the filename (without the .png extension). +