Skip to content

Commit f238153

Browse files
docs: correct typos in README and link to contribution guidelines
1 parent ba882be commit f238153

File tree

1 file changed

+3
-33
lines changed

1 file changed

+3
-33
lines changed

README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ OverKeys can be installed through several methods:
184184
- Download and run the latest [EXE installer](https://github.com/conventoangelo/OverKeys/releases/latest).
185185

186186
3. **Portable Version**
187-
- Downloade and extract the [portable ZIP file](https://github.com/conventoangelo/OverKeys/releases/latest)
187+
- Download and extract the [portable ZIP file](https://github.com/conventoangelo/OverKeys/releases/latest)
188188

189189
For detailed installation instructions, see the [Installation Guide](/docs/getting-started/installation.md).
190190

@@ -221,44 +221,14 @@ Complete documentation for OverKeys is available in the [docs](docs/index.md) fo
221221

222222
## Contributing
223223

224-
Contributions are what make the open-source community such an amazing place to learn and collaborate. Any contributions to **OverKeys** are greatly appreciated.
224+
Contributions are what make the open-source community such an amazing place to learn and collaborate. Any contributions to **OverKeys** are greatly appreciated. If you have suggestions for improvements, bug fixes, or new features, please feel free to open an issue or submit a pull request. For detailed contribution guidelines, see the [CONTRIBUTING.md](.github/CONTRIBUTING.md) file.
225225

226-
1. Fork the Project.
227-
2. Create your Feature Branch (`git checkout -b feat/amazing-feature`).
228-
3. Commit your Changes (`git commit -m 'feat: add some amazing feature'`).
229-
4. Push to the Branch (`git push origin feat/amazing-feature`).
230-
5. Open a Pull Request.
231-
232-
### Top contributors
233-
234-
<a href="https://github.com/conventoangelo/OverKeys/graphs/contributors">
235-
<img src="https://contrib.rocks/image?repo=conventoangelo/OverKeys" alt="contrib.rocks image" />
236-
</a>
237-
238-
## Building from Source
239-
240-
1. **Prerequisites**:
241-
242-
- Install [Flutter](https://flutter.dev/docs/get-started/install)
243-
- Install [Git](https://git-scm.com/downloads/win)
244-
245-
2. **Clone and Build**:
246-
247-
```pwsh
248-
git clone https://github.com/conventoangelo/OverKeys.git
249-
cd OverKeys
250-
flutter pub get
251-
flutter run -d windows # For testing
252-
# OR
253-
flutter build windows # For release build
254-
# Release executable is located at `build\windows\x64\runner\Release`
255-
```
256226

257227
<p align="right">(<a href="#readme-top">back to top</a>)</p>
258228

259229
## License
260230

261-
Distributed under the GPL-3.0 License. See `LICENSE` file for more information.
231+
Distributed under the GPL-3.0 License. See [`LICENSE`](LICENSE) file for more information.
262232

263233
<p align="right">(<a href="#readme-top">back to top</a>)</p>
264234

0 commit comments

Comments
 (0)