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 GitHub
parent 448f090e03
commit b2a5c77074
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 11 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -33,6 +33,16 @@ It was forked from Calckey Firefish (itself a fork of Misskey) in mid-2023, to f
* YunoHost Store: <https://apps.yunohost.org/app/iceshrimp>
* Report a bug: <https://github.com/YunoHost-Apps/iceshrimp_ynh/issues>
## Customising assets and locale
* To add custom CSS for all users, edit `/var/www/iceshrimp/custom/assets/instance.css`.
* To add static assets (such as images for the splash screen), place them in the `/var/www/iceshrimp/custom/assets/` directory. They'll then be available on <https://example.com/static-assets/filename.ext>.
* To add custom locales, place them in the `/var/www/iceshrimp/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 `/var/www/iceshrimp/custom/assets/badges` directory, replacing the files already there.
* To add custom sounds, place only mp3 files in the `/var/www/iceshrimp/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 `/var/www/iceshrimp` and try `yarn run gulp` again.
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing).
@ -45,4 +55,4 @@ or
sudo yunohost app upgrade iceshrimp -u https://github.com/YunoHost-Apps/iceshrimp_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>