|
|
@ -0,0 +1,25 @@ |
|
|
|
# Renku |
|
|
|
|
|
|
|
Renku is a simple cross platform Image Board and Booru Browser |
|
|
|
|
|
|
|
# Development |
|
|
|
|
|
|
|
## Prerequisites |
|
|
|
|
|
|
|
- Python 3.6+ |
|
|
|
- Poetry |
|
|
|
- PyEnv |
|
|
|
|
|
|
|
# Building |
|
|
|
|
|
|
|
A number of scripts have been created to help build the project |
|
|
|
|
|
|
|
- `scripts/clean.sh` This script is responsible for cleaning the working directories used during builds |
|
|
|
- `scripts/nuitka_build.sh` This script performs the required steps to compile and package the application with nuitka |
|
|
|
- `scripts/mac_app_bundle` This script performs the required steps to take a nuitka compiled application and package it for Mac OS |
|
|
|
|
|
|
|
# License |
|
|
|
|
|
|
|
Renku is licensed under the GPLv3 |
|
|
|
|
|
|
|
Additional information can be found in the LICENSE file |