diff --git a/README.md b/README.md index e69de29..2b971e0 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,62 @@ +# 📘 BRCDev Documentation Source + +This repository contains the source files for the documentation hosted at [docs.brcdev.net](https://docs.brcdev.net/), generated using GitHub Pages. + +## 🧭 Overview + +The documentation provides comprehensive guides and API references for BRCDev's Minecraft plugins, including: + +- **AuctionGUI** +- **Christmas** +- **Gangs** +- **PlayerShopGUI** +- **ShopGUI** + +This repository serves as the central hub for maintaining and updating the documentation content. + +## 🚀 Getting Started + +To contribute or run the documentation locally: + +1. **Clone the repository:** + + ```bash + git clone https://github.com/brcdev-minecraft/docs-brcdev-net.git + ``` + +2. **Navigate to the project directory:** + + ```bash + cd docs-brcdev-net + ``` + +3. **Install dependencies:** + + Depending on the documentation framework used (e.g., MkDocs, Docusaurus), install the necessary dependencies. For example, if using MkDocs: + + ```bash + pip install mkdocs + ``` + +4. **Serve the documentation locally:** + + ```bash + mkdocs serve + ``` + + Then, open [http://localhost:8000](http://localhost:8000) in your browser to view the documentation. + +*Note: Please adjust the above steps according to the specific tools and frameworks used in your project.* + +## 🛠️ Contributing + +Contributions are welcome! If you'd like to improve the documentation: + +- Fork the repository. +- Create a new branch for your changes. +- Make your edits and commit them with clear messages. +- Push your changes to your forked repository. +- Submit a pull request detailing your changes. + +For major changes or suggestions, please open an issue first to discuss your ideas. +