giovannino/sway-config-fedora
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Aleksei Bavshin 2022-06-09 23:08:39 -07:00
commit 6a03cb022b
No known key found for this signature in database
GPG key ID: 4F071603387A382A
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
README.md Normal file
View file

@ -0,0 +1,19 @@
## Sway config
Sway config is split to 3 parts:
* `sway/config` — is the main config to be installed to `/etc/sway/config`. Some light changes are applied, such as removing things we want to override later (bar, launcher, etc.).
* `sway/config.d/*.conf` — is a set of small self-contained configuration snippets with each containing the description and the list of required packages. Will be installed as `/usr/share/sway/config.d/*.conf`.
* `sway/50-fedora.conf` is a list of config snippets included by default.
## Upstream config changes sync
The process described below should used to update the configuration for a new upstream project release. The goal is to limit merges to changes since last release and to simplify tracking our local modifications.
1. Switch to the `upstream` branch
1. Overwrite the configuration file with an updated one
1. Do any pre-processing if necessary, e.g. replace variables, paths or anything else upstream buildsystem does before installing the file.
1. Commit changes, specifying the upstream release or tag in the commit message. Example: `sway: sync config with upstream release 1.8`
1. Switch to the `fedora` branch and merge changes from `upstream`
1. Update required project version in the RPM spec as necessary.