Cool_Tools/bemani-guide
1
0
Fork 0
mirror of https://github.com/yxrei/bemani-guide.git synced 2024-11-23 22:41:03 +01:00
Code Releases Activity
bemani guide, a compendium of information and guides written to ease headaches for general use.
134 Commits 2 Branches 0 Tags 46 MiB
Text 100%
b066059eea
Go to file
yurei b066059eea
Merge pull request #17 from akitakedits/readme-upd 
Add live preview instructions to README.md
2024-06-04 18:10:42 +02:00
.github/workflows Remove travis workflow and add ci 2023-08-30 17:29:20 +02:00
docs Removed all mentions of hexedit, hex edit, and the hexedits pages across ALL docs 2024-06-04 15:47:54 +02:00
site Initial push of existing project 2023-08-30 17:14:11 +02:00
theme Initial push of existing project 2023-08-30 17:14:11 +02:00
.gitignore Update .gitignore 2023-09-10 20:30:17 +02:00
CNAME Update domain 2023-11-22 16:09:11 +01:00
LICENSE Add banners & logos, change refrences to fumo.guide to two-torial 2023-11-22 16:23:32 +01:00
mkdocs_theme.yml Initial push of existing project 2023-08-30 17:14:11 +02:00
mkdocs.yml Removed all mentions of hexedit, hex edit, and the hexedits pages across ALL docs 2024-06-04 15:47:54 +02:00
README.md Update README.md 2024-06-04 18:04:19 +02:00
requirements.txt Changed theme 2023-09-10 20:24:37 +02:00

README.md

TWO-TORIAL, a compendium of information and guides written to ease headaches for general use. It also serves as a comprehensive resource, providing a structured approach to setting up rhythm games from specific franchises. This guide aims to offer clear instructions, troubleshooting tips, and essential information for enthusiasts and newcomers alike.

https://two-torial.xyz/

About

This repository houses a guide dedicated to assisting individuals in configuring and navigating the setup process for various rhythm games within this specific gaming genre. It covers essential aspects of installation, configuration, and troubleshooting, aiming to streamline the experience for users.

Contributing

We welcome contributions to TWO-TORIAL. To contribute, follow these steps:

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/LeBranch)
  3. Commit your Changes (git commit -m 'Added le feature)
  4. Push to the Branch (git push origin feature/LeBranch)
  5. Open a Pull Request

For quick local iteration, you can setup your own mkdocs environment:

  1. Install the latest Python and pip
  2. Make sure pip is up-to-date by running pip install --upgrade pip
  3. Change directory to the root of your forked project and run python -m pip install -r requirements.txt
  4. From the same root directory run python -m mkdocs serve

You can now access your live preview at http://127.0.0.1:8000/
The live preview will update in real time as changes are found in your files.

License

TWO-TORIAL is licensed under the Apache License 2.0. You can find the full text of the license in the LICENSE file.

Additional Notes

Documentation plays a crucial role in fostering understanding and accessibility within any domain. Detailed guides not only facilitate smoother experiences but also encourage the growth of communities by empowering individuals to engage more deeply. By documenting the intricacies of setup and configuration, this guide aims to support users in their journey through the realm of rhythm gaming.

Feel free to tailor or modify this template according to your preferences or specific content requirements for the repository.