From 3c85193a305a2ba33c3264f0fc1b2772a4bfa745 Mon Sep 17 00:00:00 2001 From: IceDynamix Date: Mon, 16 Dec 2019 17:08:21 +0100 Subject: [PATCH] Update README.md --- README.md | 25 ++++++++++++++++++------- 1 file changed, 18 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 46b5188..2ea75d4 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,29 @@ _converts quaver map files (.qp) to osu map files (.osz)_ --- -### step by step instructions to build the app yourself -* install python if not done yet -* install pip if necessary (should ship with python) -* its best to set up a virtual environment for the project but not necessary if you dont know how -* open cmd, nagivate to your directory -* run `pip install -r requirements.txt` to install all package dependencies (mainly pyYaml (.qua parser), pyQT5 (gui) and some QOL stuff) -* run main.py either by double clicking or running `python3 main.py` +### screenshot +![image of the gui](https://i.imgur.com/LYwGaVj.png) + +### download +https://github.com/IceDynamix/qua2osu/releases + +### step by step instructions +* download qua2osu from releases, no python needed etc. * gui should pop up, select a folder with your .qp files and select a folder to output your .osz files * choose available options (currently od, hp, hs volume, hs sample set) * click convert * done +### step by step instructions to build the app yourself +* install git, python if necessary +* install pip if necessary (should ship with python) +* clone this repo `git clone https://github.com/IceDynamix/qua2osu.git` +* its best to set up a virtual environment for the project but not necessary if you dont know how +* run `pip install -r requirements.txt` in the directory to install all package dependencies (mainly pyYaml (.qua parser), pyQT5 (gui) and some QOL stuff) +* run main.py either by double clicking or running `python3 main.py` +* enjoy + + ### notes if you don't select any paths then it will choose .\samples as the default input path and .\output as the default output path