mirror of
https://github.com/EnderIce2/rpc-bridge.git
synced 2025-05-25 22:14:38 +00:00
EnderIce2
ad076dfac7
Included video tutorial link for installing the LaunchAgent and bridge inside CrossOver.
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
# Documentation
|
|
|
|
> **Note:** This documentation is built and deployed using [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) (with mkdocs-video) via GitHub Actions. For the best experience, view it on the [published site](https://enderice2.github.io/rpc-bridge/) or with MkDocs locally. Some features (such as tabs, videos, or special formatting) may not display correctly in plain Markdown viewers.
|
|
|
|
This repository contains the documentation for the project. It is written in Markdown and rendered using MkDocs.
|
|
|
|
## Getting Started
|
|
|
|
To view the documentation locally, install the required Python packages:
|
|
|
|
```bash
|
|
pip install mkdocs mkdocs-material mkdocs-video
|
|
```
|
|
|
|
Once installed, you can serve the documentation locally by running:
|
|
|
|
```bash
|
|
mkdocs serve
|
|
```
|
|
|
|
This will start a local web server and you can view the documentation in your browser at `http://127.0.0.1:8000`.
|
|
|
|
## Contributing
|
|
|
|
If you want to contribute to the documentation, please follow these steps:
|
|
|
|
1. Fork the repository.
|
|
2. Make your changes in a branch.
|
|
3. Submit a pull request.
|
|
|
|
Please ensure that your changes are consistent with the existing style and structure of the documentation.
|
|
|
|
## License
|
|
|
|
This documentation is licensed under the MIT License. See the LICENSE file for more information.
|