Skip to content

Commit 00bc615

Browse files
committed
docs(contributing): add 'how to add new presets' guide
1 parent 064c8ed commit 00bc615

File tree

2 files changed

+26
-0
lines changed

2 files changed

+26
-0
lines changed

CONTRIBUTING.md

+19
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,17 @@ Reading and following these guidelines will help us make the contribution proces
66

77
## Quicklinks
88

9+
<!-- vim-markdown-toc GFM -->
10+
911
- [Code of Conduct](#code-of-conduct)
1012
- [Getting Started](#getting-started)
1113
- [Issues](#issues)
1214
- [Pull Requests](#pull-requests)
15+
- [How to add new presets?](#how-to-add-new-presets)
1316
- [License](#license)
1417

18+
<!-- vim-markdown-toc -->
19+
1520
## Code of Conduct
1621

1722
We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](./CODE_OF_CONDUCT.md).
@@ -90,6 +95,20 @@ cargo clippy --verbose -- -D warnings
9095

9196
11. The PR will be merged once you have the sign-off of the repository owners.
9297

98+
### How to add new presets?
99+
100+
I'm glad you asked!
101+
102+
1. Add your sound files to [`sounds/`](sounds/). Currently, only the [MP3](https://en.wikipedia.org/wiki/MP3) format is supported.
103+
104+
2. Configure the preset in [`config/daktilo.toml`](./config/daktilo.toml). See [adding custom presets](README.md#adding-custom-presets).
105+
106+
3. Update [`README.md`](README.md) about the availability of this new preset.
107+
108+
4. Create a pull request. See above.
109+
110+
5. Profit.
111+
93112
## License
94113

95114
By contributing, you agree that your contributions will be licensed under [The MIT License](./LICENSE-MIT) or [Apache License 2.0](./LICENSE-APACHE).

README.md

+7
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ Now you can recreate this moment without the actual need for a physical typewrit
4242
- [Similar Projects](#similar-projects)
4343
- [Acknowledgements](#acknowledgements)
4444
- [Donations](#donations)
45+
- [Contributing](#contributing)
4546
- [License](#license)
4647
- [Copyright](#copyright)
4748

@@ -289,6 +290,12 @@ Kudos! 👾
289290

290291
If you find **daktilo** and/or other projects on my [GitHub](https://github.com/orhun) useful, consider supporting me on [GitHub Sponsors](https://github.com/sponsors/orhun) or [becoming a patron](https://www.patreon.com/join/orhunp)!
291292

293+
## Contributing
294+
295+
See our [Contribution Guide](./CONTRIBUTING.md) and please follow the [Code of Conduct](./CODE_OF_CONDUCT.md) in all your interactions with the project.
296+
297+
Also, see how you can add new presets [here](CONTRIBUTING.md#how-to-add-new-presets).
298+
292299
## License
293300

294301
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat&logo=GitHub&labelColor=1D272B&color=819188&logoColor=white)](./LICENSE-MIT)

0 commit comments

Comments
 (0)