splatink/omnisearch
1
0
Fork 0
mirror of https://git.bwaaa.monster/omnisearch synced 2026-03-25 17:19:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README.md with customisation instructions

Browse Source
This commit is contained in:
frosty
2026-03-17 14:13:20 -04:00
parent b8663b4c9f
commit 69363b6cf5
1 changed files with 18 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@@ -62,7 +62,24 @@ Replace `<init>` with your init system (openrc,systemd,runit,s6)
## Hosting
Run it normally behind a reverse proxy (like nginx)
## Customisation
To make your own changes while still being able to receive upstream updates:
```
$ git checkout -b my-changes
```
Make your changes in the cloned folder, then periodically merge upstream:
```
$ git fetch origin
$ git merge origin/master
```
If there are conflicts in the files you modified, resolve them manually. You should also make the changes to the cloned repository, and then run the install command again if you installed omnisearch. Changes made directly to the configuration/assets folder will be overwritten on reinstall.
## Contribution
Generate a patch with ```git format-patch HEAD~1``` and email to [gabriel@bwaaa.monster](mailto:gabriel@bwaaa.monster), beginning the subject line with [PATCH omnisearch]
*If you are sending a revised version of a previous patch, please use [PATCH omnisearch v2, v3, etc].*
*If you are send
ing a revised version of a previous patch, please use [PATCH omnisearch v2, v3, etc].*