jachym/dwl-patches
1
0
Fork 0
mirror of https://codeberg.org/dwl/dwl-patches.git synced 2025-10-26 17:54:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update Home

A Frederick Christensen 2023-12-27 02:33:36 +00:00
parent b42987c3c9
commit a51eff2307
1 changed files with 18 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Home.md

@ -1,19 +1,26 @@
## Wiki
Welcome to dwl wiki! Feel invited to contribute your specific knowledge to this page.
A general dwl [wiki](https://codeberg.org/dwl/dwl/wiki) is available at the main [dwl](https://codeberg.org/dwl/dwl) page. This repository and wiki, by contrast, deals exclusively with dwl patches.
Welcome to dwl-patches wiki!
A general dwl [wiki](https://codeberg.org/dwl/dwl/wiki) is available at the main [dwl](https://codeberg.org/dwl/dwl) page.
This repository and wiki is exclusively for dwl PATCHES.
## Patching
Since dwl follows [suckless](https://suckless.org/) philosophy it doesn't provide every feature under the sun. To broaden dwl's functionality one needs to get familiar with a concept of patching. To get your feet wet, consult [the hacking page](https://suckless.org/hacking/) of the suckless website. Once you're ready to customize your build, proceed to the [dwl-patches wiki](https://codeberg.org/dwl/dwl-patches/wiki) (hint, you're probably already there reading this) which contains a categorized list of all patches available or search them directly via sidebar on the right section of this page.
Since dwl follows [suckless](https://suckless.org/) philosophy it doesn't provide every feature under the sun. To broaden dwl's functionality one needs to get familiar with a concept of patching. To get your feet wet, consult [the hacking page](https://suckless.org/hacking/) of the suckless website. Once you're ready to customize your build, proceed to the [dwl-patches wiki](https://codeberg.org/dwl/dwl-patches/wiki) (hint, you're probably already there reading this) which contains a list of all patches available or search them directly via sidebar on the right section of this page.
**Note**: these external patches are user-submitted content, and the authors of dwl cannot monitor them. Please download and review a patch before using it!
## Creating Patches
Create a [Codeberg](https://codeberg.org) account and clone the [dwl](https://codeberg.org/dwl/dwl) repository. Create a branch in your repository for the patch you are generating and maintaining.
1. Create a [Codeberg](https://codeberg.org) account and fork the [dwl](https://codeberg.org/dwl/dwl) repository.
2. Create a branch in your repository for the patch you are generating and maintaining.
3. Make AND TEST the modifications for your patch.
## Contributing Patches to this Wiki
1. Clone https://codeberg.org/dwl/dwl-patches.wiki.git to your codeberg.org wiki
2. Submit a pull request to the [DWL-PATCHES](https://codeberg.org/dwl/dwl-patches/) repository (NOT the main dwl repository)
You may wish to submit a screenshot of your patch and link to it from your patch's wiki page. Submit patch screenshots at https://codeberg.org/dwl/dwl-patshes/wiki/screenshots and link/include them in your individual patch's wiki page.
We will assume for the purposes of documentation that you are working on a patch called `example-mod`
1. If work has been done to the main branch at [dwl](https://codeberg.org/dwl/dwl) since you started work on your patch, REBASE YOUR PATCH!
2. In your local clone of your codeberg dwl fork add a remote for the main dwl repository like this: `git remote add codeberg-dwl https://codeberg.org/dwl/dwl`
3. Create a .patch file like this in your local clone of your Codeberg dwl fork: `git --diff codeberg-dwl/main > example-mod.patch`
4. Clone https://codeberg.org/dwl/dwl-patches
5. Add a directory called `example-mod` and in that directory a file `example-mod.patch`. You may also place screenshots in this directory that you can later reference in your [dwl-patches](https://codeberg.org/dwl/dwl-patches) wiki entry.
6. Use the Codeberg web interface to send a pull request (PR) to [dwl-patches](https://codeberg.org/dwl/dwl-patches) (NOT to [dwl](https://codeberg.org/dwl/dwl))
7. WHEN YOUR PULL REQUEST IS APPROVED, your Codeberg user will have commit access to [dwl-patches](https://codeberg.org/dwl/dwl-patches) and you can then update and maintain your `example-mod.patch` file as you see fit. At this point, you will also have access to commit to the [dwl-patches](https://codeberg.org/dwl/dwl-patches) wiki and you can add a wiki page describing your patch and perhaps linking your Codeberg repository location as well. This would allow users to later push pull requests to YOU should they find that your patch needs updating.
8. Please add your patch to the [dwl-patches wiki list](https://codeberg.org/dwl/dwl-patches/wiki).
9. Please periodically update and rebase your patch and push the `example-mod.patch` file back up to the proper directory on [dwl-patches](https://codeberg.org/dwl/dwl-patches)