Cool_Tools/two-torial
1
0
Fork 0
mirror of https://github.com/yxrei/two-torial.git synced 2024-11-27 17:00:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
TWO-TORIAL, a compendium of information and guides written to ease headaches for general use.
255 Commits 2 Branches 0 Tags 59 MiB
Pip Requirements 100%
03b246abf7
Go to file
Akitake 03b246abf7 chuni: remove dead #gpio anchors
2024-09-04 08:06:49 +02:00
.github/workflows Update setup-python version 2024-07-12 11:07:38 +02:00
docs chuni: remove dead #gpio anchors 2024-09-04 08:06:49 +02:00
.gitignore Add section on SEGA error codes 2024-07-09 21:23:17 +07: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.yml Replaced previous SUN PLUS guide with the better LUMINOUS guide. Also added NEW/NEW PLUS/SUN guides. Cleaned up img/chunithm/ folder to make adding future games simpler. 2024-07-19 20:18:07 +01:00
README.md Update README.md 2024-07-11 15:43:50 +02:00
requirements.txt Add new plugin to requirements 2024-07-12 10:45:53 +02:00

README.md

TWO-TORIAL, a compendium of information and guides about arcade games. It also serves as a comprehensive resource, providing a structured approach to setting up arcade 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 arcade games within this specific gaming genre. It covers essential aspects of installation, configuration, and troubleshooting, aiming to streamline the experience for users.

Contributing

More detailed instructions and guidelines are coming within a few days, stay tuned!

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

The TWO-TORIAL team does not provide any tools to circumvent software copy protection, nor distribute any copyright-protected game data.

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.