Add readme

This commit is contained in:
txtsd 2022-01-29 17:06:15 +00:00
parent e7c4f977ab
commit 06d697c2a2
No known key found for this signature in database
GPG Key ID: 8E0D55E9A2557BB5

36
README.md Normal file
View File

@ -0,0 +1,36 @@
# PolyMC Meta
Scripts to generate jsons and jars that PolyMC will access.
## Usage
### Install the dependencies
As root:
```
sudo pip install requirements.txt
```
Or as user:
```
pip install --user requirements.txt
```
### Initial setup
This will clone [meta-polymc](https://github.com/PolyMC/meta-polymc) and [meta-upstream](https://github.com/PolyMC/meta-upstream)
```
./clone.sh
```
### Generate files
This will run the main script and do its magic
```
./update.sh
```
### Check status of meta-polymc and meta-upstream
```
./status.sh
```