From 2bd77daf4a48da7b99809c764696603a15b1367f Mon Sep 17 00:00:00 2001 From: Drew Short Date: Sun, 19 Jul 2020 21:49:35 -0500 Subject: [PATCH] Added an initial README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..0dac05a --- /dev/null +++ b/README.md @@ -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