Skip to content

Commit

Permalink
docs: moved documentation from root dir to docs/
Browse files Browse the repository at this point in the history
  • Loading branch information
iruzo committed May 28, 2024
1 parent 65a2cd6 commit 4fadf58
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
File renamed without changes.
File renamed without changes.
16 changes: 8 additions & 8 deletions CONTRIBUTING.md → docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Information regarding the architecture of the project can be found [in the ARCHI

### Project structure

`sources/` contains all of the source files needed for the project to build, including the Colloid submodule.
`sources/` contains all of the source files needed for the project to build, including the Colloid submodule.
It also contains our patches for Colloid, alongside the core build system implemented by us to replace the one from Colloid.

`build.py` is the entrypoint to the build system, placed at the root for convenience. The plumbing this utilizes is in
Expand All @@ -23,7 +23,7 @@ This keeps the end user experience simple and reproducible. Do not add external
> If you need to change the patches, reset the submodule and rerun the build script.
We patch upstream colloid through a series of `.patch` files, applied through `git apply` once when the build begins.
The patches are located in `./patches/colloid/`.
The patches are located in `./patches/colloid/`.

Once the build script patches the submodule, it will write a file into
`colloid/.patched`, to signal to future invocations that the patches have already been applied.
Expand All @@ -39,12 +39,12 @@ Now and again, Colloid will have bugs upstream that impacts our theme. With our
but we still want to contribute the fixes upstream to benefit all users & forks of Colloid.

To avoid stalling unnecessarily, our procedure for the above is as follows:
1) Open a PR to fix the issue, by adding a patch file to our theme, add `upstream:intended`
1) Open a PR to fix the issue, by adding a patch file to our theme, add `upstream:intended`
to signal these changes are to be sent to Colloid eventually.
2) Merge the PR & close the issue in our theme pertaining to the issue, once reviewed and approved
3) Open a PR in Colloid with the patch
4) Open a new issue in our theme, with these details:
- The initial issue in our theme
- The initial issue in our theme
- The PR in Colloid that fixes the issue there
- The PR that fixed the issue in our theme

Expand All @@ -55,7 +55,7 @@ to signal these changes are to be sent to Colloid eventually.
- The tracking issue
- The commit that fixed the issue in Colloid
3) Close the tracking issue & merge the PR to remove the patch file


### Running test builds
We support building and publishing test builds from PRs. When you open PRs, the CI will automatically build with your changes and push an artifact
Expand All @@ -67,10 +67,10 @@ pass the path into `install.py` under the `--from-artifact` option:
python3 install.py mocha blue --dest ./build --from-artifact ~/downloads/7bff2448a81e36bf3b0e03bfbd649bebe6973ec7-artifacts.zip
```

This will take the target flavor / accent out of the zip, and install it using the regular install process.
This will take the target flavor / accent out of the zip, and install it using the regular install process.

It is advised to pass a `--dest` when running in this mode, because the released zips follow the exact same naming scheme as regular builds.
This wil cause conflicts when you install, if you already had that theme installed. Passing a different destination allows you to move the
This wil cause conflicts when you install, if you already had that theme installed. Passing a different destination allows you to move the
extracted folders to `~/.local/share/themes` yourself, adding a suffix as appropriate to avoid conflicts.

> [!WARNING]
Expand All @@ -79,4 +79,4 @@ extracted folders to `~/.local/share/themes` yourself, adding a suffix as approp
### Useful resources
- GNOME-shell sources: https://gitlab.gnome.org/GNOME/gnome-shell/-/tree/gnome-46/data/theme
- GTK inspector guide: https://developer.gnome.org/documentation/tools/inspector.html
- GTK inspector guide: https://developer.gnome.org/documentation/tools/inspector.html

0 comments on commit 4fadf58

Please sign in to comment.