From 9bbeec1453953a8c0532a1279835e2a7097a038b Mon Sep 17 00:00:00 2001 From: A Frederick Christensen Date: Wed, 27 Dec 2023 04:33:06 +0000 Subject: [PATCH] Update README.md --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 940e166..a41aba8 100644 --- a/README.md +++ b/README.md @@ -3,25 +3,25 @@ The dwl project is available at [https://codeberg.org/dwl/dwl](https://codeberg. This repository and the associated 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) which contains a categorized listing and a directly searchable sidebar listing of all available patches. +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 the 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) which contains a categorized listing and a searchable sidebar index of all available patches. **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](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. +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](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: -`git remote add codeberg-dwl https://codeberg.org/dwl/dwl` -3. In your local clone of your codeberg dwl fork, create a .patch file -`git --diff codeberg-dwl/main > PATCHNAME.patch` -4. Fork https://codeberg.org/dwl/dwl-patches -5. In your dwl-patches fork, add a directory called `PATCHNAME` and place the `PATCHNAME.patch` you created in the `PATCHNAME` directory. You may also place screenshots in the `PATCHNAME` directory that you can later reference in your [dwl-patches wiki](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 replace your `PATCHNAME.patch` file when you updated it. At this point, you will also have access to commit to the [dwl-patches wiki](https://codeberg.org/dwl/dwl-patches/wiki) +2. In your local clone of your Codeberg dwl fork, add a remote for the main dwl repository: + `git remote add codeberg-dwl https://codeberg.org/dwl/dwl` +3. In your local clone of your Codeberg dwl fork, create a .patch file + `git --diff codeberg-dwl/main > PATCHNAME.patch` +4. Fork [https://codeberg.org/dwl/dwl-patches](https://codeberg.org/dwl/dwl-patches) +5. In your dwl-patches fork, 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](https://codeberg.org/dwl/dwl-patches/wiki) entry. +6. Use the Codeberg web interface to send a pull request 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 also be granted commit access to [dwl-patches](https://codeberg.org/dwl/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](https://codeberg.org/dwl/dwl-patches/wiki) 8. Add a wiki page using this template (add/remove sections as you like): ```markdown ### Description