diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7877791..52892a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing to Topola -Literally anyone can contribute to Topola, including you. +*Anyone* can contribute to Topola, including you. Contributions can be of any kind: documentation, organization, tutorials, blog posts, bug reports, issues, feature requests, feature @@ -19,7 +19,8 @@ which one you join. ## Reporting issues If you believe you have found a defect in Topola or its documentation, -please report it on our [issue tracker](https://codeberg.org/topola/topola/issues). +please report it on our [issue +tracker](https://codeberg.org/topola/topola/issues). Under normal operation, crashes and panics are always considered reportable bugs. diff --git a/README.md b/README.md index ebb8c16..f2df9ed 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,15 @@ Join the official [Matrix chatroom](https://matrix.to/#/%23topola:tchncs.de) or ## Contributing -[Official repository on Codeberg](https://codeberg.org/mikolaj/topola) +*Anyone* can contribute to Topola, including you. If you want to help us out, please follow +our [Contribution guide](CONTRIBUTING.md). -[Mirror repository on GitHub](https://github.com/mikwielgus/topola) +Our official repository is on [Codeberg](https://codeberg.org/mikolaj/topola). We also have a +mirror repository on [GitHub](https://github.com/mikwielgus/topola). + +## Licence + +Topola is licensed under the [MIT licence](LICENSE). ## Gallery ![Animation. There's a rubber band-like trace following cursor, navigating a very simple maze. The maze and the trace are red, the background is solid black but also very slightly white and dark blue](./assets/interactive_routing.gif)