The documentation for the open API of rūrusetto and other information related to the project.
Please make sure you have the following prerequisites:
- Node.js with
npminstalled - Markdown editor (We recommend Visual Studio Code)
- Git
Clone the repository:
git clone https://github.com/Rurusetto/docs/
cd rurusetto-docsTo update the source code to the latest commit, run the following command inside the Rūrusetto Documentation directory:
git pullIt is recommended to install docsify-cli globally, which helps initializing and previewing the website locally.
npm i docsify-cli -gThe documentation is written in Markdown format and place in the docs directory. All documentation file are there.
Use the following command inside the main folder (not in docs):
docsify serve docsVisit Docsify documentation for more information.
If you see any typo or something wrong with the documentation, please make a new issue on the repository or you can make this more clear by creating a pull request and we will fix or review it as soon as possible.
We use code of conduct from Contributor Covenant.
This documentation use the same license as Rūrusetto.
Icon and new color scheme is designed by @IKeepItNoodles
The code in this repository is licensed under the MIT license. Please see the license file 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 images in this website and the content that is upload by the users and community are covered by DMCA. If you are the work's original owner and want to request to remove your work, please email the team by contact HelloYeew (project leader) at [email protected].
Each ruleset has its own license.
The licensing here does not directly apply to osu! and ppy, as it is bound to its own licensing.