From ec1b90316d14550863e866d4b926dd0f62997228 Mon Sep 17 00:00:00 2001 From: pontakornth Date: Sat, 2 Oct 2021 16:12:14 +0700 Subject: [PATCH] doc: Fix some grammartical error and enhance note --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2d276593..fdd4694b 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,7 @@ And when you want to get off from the virtual environment, use the `deactivate` deactivate ``` -Note : If you use PyCharm, you can click on the python interpreter and you can add the new interpreter to create a new virtual environment and when you run the command in PyCharm terminal all command will stay in virtual environment. +**Note** : If you use PyCharm, you can click on the python interpreter and you can add the new interpreter to create a new virtual environment and when you run the command in PyCharm terminal all command will stay in virtual environment. ### Install the requirement library in the virtual environment @@ -105,7 +105,7 @@ OSU_OAUTH_CLIENT_SECRET = keygohere OSU_API_V1_KEY = keygohere ``` -Note : The `OSU_OAUTH_CLIENT_ID` `OSU_OAUTH_CLIENT_SECRET` and `OSU_API_V1_KEY` are required when you want to development with osu! OAuth system or some program part that required the osu! API you must fill the osu! API key and OAuth app number in `settings.py` to start development on this function. But if you are not testing on this function it's okay to leave the key blank. (The development OAuth server callback is http://127.0.0.1:8000/accounts/osu/login/callback/.) +**Note** : The `OSU_OAUTH_CLIENT_ID` `OSU_OAUTH_CLIENT_SECRET` and `OSU_API_V1_KEY` are required when you want to development with osu! OAuth system or some program part that required the osu! API you must fill the osu! API key and OAuth app number in `settings.py` to start development on this function. But if you are not testing on this function it's okay to leave the key blank. (The development OAuth server callback is http://127.0.0.1:8000/accounts/osu/login/callback/.) ### Start the development server @@ -120,15 +120,17 @@ python manage.py runserver When it comes to contributing to the project, the two main things you can do to help out are reporting the issues and submitting pull requests. We have prepared a [list of contributing guidelines](CONTRIBUTING.md) that should hopefully ease you into our collaboration process. -Note that the contributing guidelines is not all. Nothing is set in stone. If you have an issue with the way code is structure, with any libraries we are using, or with any processes involved with contributing, please bring up and ask us! We welcome all feedback, so we can make the contributing to this project as painless as possible. +Note that the contributing guidelines is not exhaustive. Nothing is set in stone. If you have an issue with the way code is structure, with any libraries we are using, or with any processes involved with contributing, please bring up and ask us! We welcome all feedback, so we can make contributions to this project as painless as possible. We use [code of conduct](code_of_conduct.md) from `Contributor Covenant`. ## License -The code in this repository is licensed under MIT license. Please see [the license file](LICENSE) for more information. tl;dr you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source. +The code in this repository is licensed under MIT license. Please see [the license file](LICENSE) for more information. -The image in this website and the content that upload by user and community is cover on DMCA. If you are the work and owner and want to request to remove your work please email the team at [contact@rulesets.info](mailto:contact@rulesets.info) or contact HelloYeew (project leader) at [me@helloyeew.dev](mailto:me@helloyeew.dev). +TL;DR** you can do whatever you want as long as you include the original copyright and license notice in any copy of the software/source. + +The image in this website and the content that upload by user and community are cover by DMCA. If you are the work owner and want to request to remove your work, please email the team at [contact@rulesets.info](mailto:contact@rulesets.info) or contact HelloYeew (project leader) at [me@helloyeew.dev](mailto:me@helloyeew.dev). Each rulesets has its own license.