jachym/dwl-patches
1
0
Fork 0
mirror of https://codeberg.org/dwl/dwl-patches.git synced 2025-09-08 12:14:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
A Frederick Christensen 2024-01-02 17:00:26 +00:00
parent e47b369054
commit 86a43bcd97
1 changed files with 3 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -1,57 +1,5 @@
## Welcome to [dwl-patches]! ## Welcome to [dwl-patches](https://codeberg.org/dwl/dwl-patches)!
The dwl project is available at [https://codeberg.org/dwl/dwl][dwl]. The dwl project is available at [https://codeberg.org/dwl/dwl](https://codeberg.org/dwl/dwl).
This repository and the associated wiki is exclusively for dwl PATCHES. This repository and the associated wiki is exclusively for dwl PATCHES.
## Patching Please see the dwl-patches [wiki](https://codeberg.org/dwl/dwl-patches/wiki) for patch descriptions and for [instructions](https://codeberg.org/dwl/dwl-patches/wiki/instructions) on contributing/updating/reporting issues.
Since dwl follows [suckless] philosophy it doesn't provide every feature under the sun. To broaden dwl's functionality, one needs to get familiar with the concept of patching. To get your feet wet, consult [the hacking page] of the suckless website. Once you're ready to customize your build, proceed to the [dwl-patches wiki][wiki] which contains a categorized listing and a searchable sidebar index of all available patches.
Since dwl is still taking shape, patches may need to be updated after larger changes to the code. Feel free to contribute updated versions!
**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
1. Create a [Codeberg] account and fork the [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. If work has been done to the main branch at [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:
`git remote add upstream https://codeberg.org/dwl/dwl`
3. In your local clone of your Codeberg dwl fork, create a .patch file
`git format-patch upstream/main...<branch-name> --stdout > PATCHNAME.patch`
4. Fork [https://codeberg.org/dwl/dwl-patches][dwl-patches]
5. In your local copy, add a directory called `PATCHNAME` and place the `PATCHNAME.patch` you created in step three into the `PATCHNAME` directory. You may also place screenshots in the `PATCHNAME` directory that you can later reference in your [dwl-patches wiki][wiki] entry.
6. Use the Codeberg web interface to send a pull request to [dwl-patches] (NOT to [dwl])
7. WHEN YOUR PULL REQUEST IS APPROVED, your Codeberg account will also be granted commit access to [dwl-patches]. When you make updates, replace your `PATCHNAME.patch` file directly. You no longer need to make pull requests. At this point, you will also have access to commit to the [dwl-patches wiki][wiki]
8. Add a wiki page using this template (add/remove sections as you like):
```markdown
### Description
Insert a short summary of changes that your patch implements.
### Download
- [git branch](https://codeberg.org/USERNAME/dwl/src/branch/PATCHNAME)
- [yyyy-mm-dd](https://codeberg.org/dwl/dwl-patches/raw/branch/main/PATCHNAME/PATCHNAME.patch)
USE THE ^raw^ PATCH LINK HERE
### Authors
- [YOUR_NICK](https://codeberg.org/USERNAME)
```
9. Use this template to add your patch to the [wiki]'s categorized list and sidebar index:
```markdown
* [PATCHNAME](https://codeberg.org/dwl/dwl-patches/wiki/PATCHNAME)
```
10. Keep your `PATCHNAME.patch` file AND the associated wiki page updated appropriately.
## Reporting Issues
Generally, patches have a link to the git branch of the author's fork linked in the wiki page. Please report issues with an author's patch in the appropriate branch of that author's fork. If you open an issue here regarding a patch's functionality, the issue will be closed with a reference to the instructions here.
## Updating/Modifying Existing Patches
1. If the existing patch is being maintained by another author, do not make modifications to it without permission.
2. If you have submitted a pull request to the previous author's repository and received no reply after seven days, please feel free to edit the wiki page for the patch with your updated link. Do leave any previous author's nicks/links intact under the "Authors" heading.
[dwl-patches]: https://codeberg.org/dwl/dwl-patches
[Codeberg]: https://codeberg.org
[dwl]: https://codeberg.org/dwl/dwl
[wiki]: https://codeberg.org/dwl/dwl-patches/wiki
[suckless]: https://suckless.org/
[the hacking page]: https://suckless.org/hacking/