Skip to content

Commit f55d6cb

Browse files
authored
Revise installation, usage, and add contributing section
Updated installation and usage sections, added contributing guidelines.
1 parent 743e5e8 commit f55d6cb

1 file changed

Lines changed: 29 additions & 4 deletions

File tree

‎README.md‎

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,7 @@ It is especially useful for students, note-takers, and anyone who wants the aest
2222

2323
---
2424

25-
## 🚀 How do I use it?
26-
27-
### Installation
25+
## 🚀 Installation
2826

2927
1. Download the latest **Installer.exe** from the [Releases](https://github.com/pythonIsFast/Text2Pen/releases/latest) page.
3028
2. Run `Installer.exe` and click **Install**.
@@ -33,7 +31,7 @@ It is especially useful for students, note-takers, and anyone who wants the aest
3331
- The updater (`Update.exe`) is registered to run on startup.
3432
3. Launch **Text2Pen** from the Start Menu.
3533

36-
### Usage
34+
## ▶️ Usage
3735

3836
1. Open Microsoft OneNote and navigate to the page where you want to write.
3937
2. Start **Text2Pen**.
@@ -126,3 +124,30 @@ You can disable telemetry at any time in the application settings. Once disabled
126124
### 8. Contact
127125

128126
If you have questions about privacy or data handling, please open a [GitHub Issue](https://github.com/pythonIsFast/Text2Pen/issues).
127+
128+
## 🤝 Contributing
129+
130+
Contributions are welcome and appreciated.
131+
132+
### How to contribute
133+
134+
1. Fork the repository
135+
2. Create a new branch (`feature/your-feature-name`)
136+
3. Make your changes
137+
4. Commit your changes
138+
5. Open a pull request
139+
140+
### What you can contribute
141+
142+
- Bug fixes
143+
- Performance improvements
144+
- UI/UX enhancements
145+
- Documentation improvements
146+
147+
### Guidelines
148+
149+
- Keep changes focused and minimal
150+
- Write clear commit messages
151+
- Ensure the application still works correctly
152+
153+
For larger changes, please open an issue first to discuss your idea.

0 commit comments

Comments
 (0)