Update Home

A Frederick Christensen 2023-12-27 03:47:28 +00:00
parent 9bc4a98391
commit 0114296e89

40
Home.md

@ -1,42 +1,8 @@
## Wiki ## Wiki
Welcome to the [dwl-patches](https://codeberg.org/dwl/dwl-patches) wiki! Welcome to the [dwl-patches](https://codeberg.org/dwl/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. * 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. * This repository and wiki is exclusively for dwl PATCHES.
* See the [main page]() of this repository for instructions on generating and submitting 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 listing and a directly searchable sidebar listing 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.
## 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 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 > PATCHNAME.patch`
4. Clone https://codeberg.org/dwl/dwl-patches
5. Add a directory called `PATCHNAME` and in that directory a file called `PATCHNAME.patch`. You may also place screenshots in this 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 update and maintain your `PATCHNAME.patch` file as you see fit. 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:
```markdown
### Description
Insert a short summary of changes that your patch implements.
### Download
- [yyyy-mm-dd](https://codeberg.org/dwl/dwl-patches/src/branch/main/PATCHNAME/PATCHNAME.patch)
### Authors
- [Your Name](https://codeberg.org/YOURUSERNAME)
```
9. Please add your patch to the [dwl-patches wiki](https://codeberg.org/dwl/dwl-patches/wiki) categorized list and alphabetized sidebar using this template:
```markdwon
* [PATCHNAME](https://codeberg.org/dwl/dwl-patches/wiki/PATCHNAME)
```
10. Please periodically update and rebase your patch and push the `PATCHNAME.patch` file back up to the proper directory on [dwl-patches](https://codeberg.org/dwl/dwl-patches)
## AVAILABLE PATCHES: ## AVAILABLE PATCHES:
### Layouts ### Layouts