mirror of
https://github.com/MacRimi/ProxMenux.git
synced 2025-06-28 04:06:54 +00:00
27 lines
778 B
Markdown
27 lines
778 B
Markdown
|
# ProxMenux
|
||
|
|
|
||
|
|
ProxMenux is a menu-driven script for Proxmox VE management. This repository contains both the core ProxMenux tool and its documentation website.
|
||
|
|
|
||
|
|
## Project Structure
|
||
|
|
|
||
|
|
- `/web`: Contains the Next.js website for ProxMenux documentation
|
||
|
|
- `/guides`: Markdown files for various guides
|
||
|
|
- `CHANGELOG.md`: Project changelog
|
||
|
|
|
||
|
|
## Getting Started
|
||
|
|
|
||
|
|
To run the documentation website locally:
|
||
|
|
|
||
|
|
1. Navigate to the `/web` directory
|
||
|
|
2. Install dependencies: `npm install`
|
||
|
|
3. Run the development server: `npm run dev`
|
||
|
|
|
||
|
|
## Deployment
|
||
|
|
|
||
|
|
This project is set up for automatic deployment to GitHub Pages using GitHub Actions. Any push to the `main` branch will trigger a new build and deployment.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
Contributions are welcome! Please feel free to submit a Pull Request.
|
||
|
|
|