Skip to content

Commit 1b7155c

Browse files
authored
chore: update readme
1 parent 3eb4cd2 commit 1b7155c

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
| --- | :-: |
77
| **Version:** | [![GitHub tag](https://img.shields.io/github/tag/FlysonBot/Mastermind?include_prereleases=&sort=semver&color=blue)](https://github.com/FlysonBot/Mastermind/tags) [![GitHub Release](https://img.shields.io/github/v/release/FlysonBot/Mastermind?include_prereleases)](https://github.com/FlysonBot/Mastermind/releases) [![Python Version](https://img.shields.io/pypi/pyversions/mastermind-ai)](https://www.python.org/downloads/) [![PyPI - Version](https://img.shields.io/pypi/v/mastermind-ai)](https://pypi.org/project/mastermind-ai/) |
88
| **Activity:** | [![Opened Issue Count](https://img.shields.io/github/issues/FlysonBot/Mastermind?color=teal)](<https://github.com/FlysonBot/Mastermind/issues>) [![Closed Issue Count](https://img.shields.io/github/issues-closed/FlysonBot/Mastermind?color=teal)](https://github.com/FlysonBot/Mastermind/issues?q=is%3Aissue+is%3Aclosed) [![Closed PR Count](https://img.shields.io/github/issues-pr-closed/FlysonBot/Mastermind?color=teal)](https://github.com/FlysonBot/Mastermind/pulls?q=is%3Apr+is%3Aclosed) |
9-
| **Meta:** | [![GitHub License](https://img.shields.io/github/license/FlysonBot/Mastermind)](https://github.com/FlysonBot/Mastermind/blob/main/LICENSE) ![PyPI Status](https://img.shields.io/pypi/status/mastermind-ai) ![Repo Size](https://img.shields.io/github/repo-size/FlysonBot/Mastermind) |
9+
| **Meta:** | [![GitHub License](https://img.shields.io/github/license/FlysonBot/Mastermind)](https://github.com/FlysonBot/Mastermind/blob/main/LICENSE) ![PyPI Status](https://img.shields.io/pypi/status/mastermind-ai) ![Repo Size](https://img.shields.io/github/repo-size/FlysonBot/Mastermind) [![PyPI - Downloads](https://img.shields.io/pypi/dw/mastermind-ai)](https://pypi.org/project/mastermind-ai/) |
1010

1111
> [!NOTE]
1212
> This repo is currently still under development. Currently there is a beta version that have the basic simulation feature finished. If you encountered any issue, please open up an issue and let me know! I will try to fix them as soon as possible.
@@ -20,6 +20,7 @@
2020
- [Changelog](https://github.com/FlysonBot/Mastermind/blob/main/CHANGELOG.md)
2121
- [Contributing](https://github.com/FlysonBot/Mastermind/blob/main/.github/CONTRIBUTING.md)
2222
- [Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/.github/CODE_OF_CONDUCT.md)
23+
- [Play Online on Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb)
2324

2425
# Mastermind
2526

@@ -29,6 +30,12 @@
2930

3031
Mastermind is a code-breaking game for two players. The first player (the code-setter) creates a secret code, which the second player (the code-cracker) tries to guess. The code-cracker has a limited number of attempts to guess the code correctly. After each guess, the code-setter provides feedback to the code-cracker, indicating how many dots have the right color and are in the right place, and how many are the right color but in the wrong place. The code-cracker uses this feedback to refine their guesses until they correctly guess the code or run out of attempts.
3132

33+
## Contribution Wanted!!!
34+
35+
Currently the project only has 1 contributor, me, and I'm getting busy on schoolwork. Please come and contribtue! You don't need to know how to code to contribute. Simple open up [issues](https://github.com/FlysonBot/Mastermind/issues) or [discussion](https://github.com/FlysonBot/Mastermind/discussions) when you found bugs or have some suggestion to the project.
36+
37+
If you want to contribute to the code, feel free to fork and submit pull request! Try to follow the [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/) style when writing commit message. Any help is appreciated! To get started, you can take a look at the issues labeled as [good first issue](https://github.com/FlysonBot/Mastermind/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) which contain a list of tasks that are easy to do that can help you get started with contributing to the project!
38+
3239
## Getting Started
3340

3441
### Prerequisites
@@ -38,7 +45,7 @@ To run this project, you must have the following installed (installation guide b
3845
- Python 3.10 (or higher)
3946
- pip (comes with Python, needed to install the project as a library)
4047

41-
Or alternatively you can run this program in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/mastermind_in_colab.ipynb)
48+
Or alternatively you can run this program in your browser with [Google Colab](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb)
4249

4350
### Installation Guide
4451

@@ -104,7 +111,7 @@ Contributions are welcome! Please open an issue or submit a pull request.
104111

105112
All contributors must adhere to the [Contributor Covenant Code of Conduct](https://github.com/FlysonBot/Mastermind/blob/main/.github/CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for all contributors.
106113

107-
To contribute to the code directly, you must also follow the [Contributing Guidelines](https://github.com/FlysonBot/Mastermind/blob/main/CONTRIBUTING.md) to ensure a smooth and efficient collaboration process.
114+
To contribute to the code directly, you must also follow the [Contributing Guidelines](https://github.com/FlysonBot/Mastermind/blob/main/.github/CONTRIBUTING.md) to ensure a smooth and efficient collaboration process.
108115

109116
## License
110117

0 commit comments

Comments
 (0)