mirror of
https://github.com/blw1138/cross-py-builder.git
synced 2025-12-17 08:38:11 +00:00
Update README.md
This commit is contained in:
83
README.md
83
README.md
@@ -1,3 +1,84 @@
|
||||
# Cross-Py-Build
|
||||
|
||||
Cross-Py-Build is a simple remote build tool for compiling Python projects with PyInstaller on different platforms.
|
||||
Cross-Py-Build is a simple remote build tool for compiling Python projects with PyInstaller on different platforms on a local network.
|
||||
|
||||
## System Requirements
|
||||
- **Ubuntu/Debian & macOS:** 2GB+ RAM
|
||||
- **Windows:** 4GB+ RAM
|
||||
- **Python 3** installed
|
||||
- **Local Network** for build agents
|
||||
|
||||
---
|
||||
|
||||
### Example Usage
|
||||
|
||||
|
||||
```sh
|
||||
./agent_manager.py --build /path/to/repo -cpu x64 -os windows
|
||||
|
||||
options:
|
||||
-h, --help show this help message and exit
|
||||
--status Get status of available servers
|
||||
--build BUILD Path to the project to build
|
||||
-cpu CPU CPU architecture
|
||||
-os OS Operating system
|
||||
-d, --download Download after build
|
||||
--delete-cache Delete cache
|
||||
--update-all Update build agent
|
||||
--restart RESTART Hostname to restart
|
||||
--restart-all Restart all agents
|
||||
--shutdown SHUTDOWN Hostname to shutdown
|
||||
--shutdown-all Restart all agents
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Worker VM Setup Guide
|
||||
|
||||
This guide provides steps to set up a worker VM on **Ubuntu/Debian, macOS, or Windows**.
|
||||
|
||||
|
||||
### Ubuntu/Debian or macOS
|
||||
1. **Create a new VM** and install the OS.
|
||||
2. **Update the system:**
|
||||
- **Ubuntu/Debian:**
|
||||
```sh
|
||||
sudo apt update && sudo apt upgrade -y
|
||||
sudo apt install python3-pip python3-venv -y
|
||||
```
|
||||
- **macOS:**
|
||||
```sh
|
||||
xcode-select --install # Install xcode tools
|
||||
```
|
||||
- Install Python 3.x from [python.org](https://www.python.org/downloads/)
|
||||
- **Windows:**
|
||||
- Install Python 3.x from [python.org](https://www.python.org/downloads/)
|
||||
|
||||
|
||||
3. **Set up a virtual environment:**
|
||||
|
||||
- **Ubuntu/Debian/macOS:**
|
||||
```sh
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
- **Windows:**
|
||||
```sh
|
||||
python3 -m venv venv
|
||||
source venv\Scripts\activate
|
||||
```
|
||||
4. **Copy project files** and install dependencies:
|
||||
```sh
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
5. **Start Build Agent**:
|
||||
- **Ubuntu/Debian/macOS:**
|
||||
```sh
|
||||
python3 build_agent.py
|
||||
```
|
||||
- **Windows:**
|
||||
```sh
|
||||
python build_agent.py
|
||||
```
|
||||
---
|
||||
Reference in New Issue
Block a user