> For the complete documentation index, see [llms.txt](https://anufrievroman.gitbook.io/waypaper/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://anufrievroman.gitbook.io/waypaper/support-and-contribution.md).

# Support and contribution

### Contributions

Feel free to propose PR and suggest the improvements. I'll highly appreciate help with packaging for various distributions. If you wish to contribute with translation into your language, please see the `translations.py` file.\
\
If you'd like to contribute to the documentation, please make pull requests to [this repository](https://github.com/anufrievroman/waypaper-docs).

#### Contribution Instructions

1. Fork the `waypaper` repository on Github.
2. Clone your fork of `waypaper`

```bash
git clone https://github.com/YOUR_GITHUB_USERNAME/waypaper.git
```

3. Enter the repository directory.

```bash
cd waypaper
```

4. Create the folder for the virtual environment.

```bash
mkdir venv
```

5. Create the Python virtual environment.

```bash
python3 -m venv venv
```

6. Source the Python virtual environment.

```bash
source venv/bin/activate
```

**Note**: If you are using the `fish` shell use `activate.fish` instead.

7. Install `waypaper` to the virtual environment.

```bash
pip install -e .
```

**Note**: If the compilation of dependencies fail, try downloading `gobject-introspection` and `cairo` from your distributions package manager.

8. Run the `waypaper` executable

```bash
waypaper
```

**Note**: If you are using a debugger while developing, it will use the `waypaper` from the virtual environment and you can make changes to the source code and they will be reflected when you call `waypaper` from the virtual environment.

9. Once you are ready to commit, please enter a message that describes your additions and (if applicable) cite the Github issue you are addressing with the #NUMBER syntax.
10. Create a pull request with your changes `waypaper` main. Please describe what you addressed or added and (if applicable) cite the Github issue. If necessary, please describe technical details of your implementation.

### Support

I am not a professional developer and work on this project in my free time. If you'd like to support the development, consider donations via:

* Card or PayPal <https://buymeacoffee.com/angryprofessor>
* BTC `bc1qpkzmutdqfxkce34skt09vll97s5smpa0r2tyzj`
* ETH `0x6f1Ce9cA181458Fc153a5f7cBF88044736C3b00C`
* BNB `0x40f22c372758E35C905458cAF8BB17f51ac133d1`
* LTC `ltc1qtu33qyv2xlzxda5mmrmk943zpksq8q75tuh85p`
* XMR `4AHRhpNYUZcPVN78rbUWAzBuvMKQdpwStS5L3kjunnBMWWW2pjYBko1RUF6nQVpgQPdfAkM3jrEWrWKDHz1h4Ucd4gFCZ9j`


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://anufrievroman.gitbook.io/waypaper/support-and-contribution.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.