<p align="center">
  <img src="https://github.com/two-torial/two-torial/blob/master/docs/img/two-torial/github-banner.webp?raw=true">
</p>

#

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

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](https://www.mkdocs.org/user-guide/installation/) environment:

1. Install the latest [Python](https://www.python.org/) and [uv](https://docs.astral.sh/uv/#installation)
2. Change directory to the root of your forked project and run `uv sync`
3. From the same root directory run `uv run mkdocs serve`
4. You can also add `--dirty` at the end of the above command to speed up live reloads, but rendering errors could occur

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](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.
