YunoHost-Apps/iceshrimp_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/iceshrimp_ynh.git synced 2024-09-03 19:15:54 +02:00
Code Issues Activity Actions

Update README.md

Browse source 
Added customization directions with note for gulp not found error message
This commit is contained in:
alcapurrias 2024-03-16 14:10:54 -05:00 committed by Félix Piédallu
parent 2754174241
commit 4be51a0bb5
1 changed files with 9 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/ADMIN.md Normal file
View file

@ -0,0 +1,9 @@
## Customising assets and locale
* To add custom CSS for all users, edit `__INSTALL_DIR__/custom/assets/instance.css`.
* To add static assets (such as images for the splash screen), place them in the `__INSTALL_DIR__/custom/assets/` directory. They'll then be available on <https://__DOMAIN__/static-assets/filename.ext>.
* To add custom locales, place them in the `__INSTALL_DIR__/custom/locales/` directory. If you name your custom locale the same as an existing locale, it will overwrite it. If you give it a unique name, it will be added to the list. Also make sure that the first part of the filename matches the locale you're basing it on. (Example: en-FOO.yml)
* To add custom error images, place them in the `__INSTALL_DIR__/custom/assets/badges` directory, replacing the files already there.
* To add custom sounds, place only mp3 files in the `__INSTALL_DIR__/custom/assets/sounds` directory.
* To update custom assets without rebuilding, just run `yarn run gulp`.
* If a `gulp not found` error is received, run `yarn global add gulp-cli` then `yarn install` in `__INSTALL_DIR__` and try `yarn run gulp` again.