From 66267e72dd6131ad4544036f6c4737c16e2bb832 Mon Sep 17 00:00:00 2001 From: Daniel Seiller Date: Sat, 28 Sep 2019 15:41:56 +0200 Subject: [PATCH] docs: Update README.md --- README.md | 61 ++++++++++++++++++++++++------------------------------- 1 file changed, 26 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 2723c76..4a8269c 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,38 @@ # Prerequisites -- conda (miniconda/anaconda) +- Python: + - conda (miniconda/anaconda) + - tox (`conda install tox`) + - Inno Setup Compiler + - Download from [here](http://www.jrsoftware.org/isdl.php) + - or install via [scoop](https://scoop.sh/) `scoop install inno-setup`) - Visual Studio 2019 - nightly rust compiler (`x86_64-pc-windows-msvc`) -# Testing +# Building an installer + +(Assuming `conda` is in your `PATH`) + +1. Start a Visual Studio 2019 x64 command prompt +2. Run `tox` +3. Grab the installer from `installer/Output/` + +# Installing + +(Assuming `conda` is in your `PATH`) + +1. Start a Visual Studio 2019 x64 command prompt +2. Run the following commands: -```bash -conda create -n ed_lrr_gui_env python=3 -conda activate ed_lrr_gui_env -python build_gui.py -pip install -e . -rs_gui_test ``` - -# Building - -```bash -conda create -n ed_lrr_gui_env python=3 -conda activate ed_lrr_gui_env +conda install pycrypto nuitka +pip install PyQt5 setuptools_rust python build_gui.py -pip install setuptools_rust pyinstaller pip install . -python setup.py build -python setup.py bdist_wheel -python setup.py sdist -mkdir exe -cd exe -pyinstaller --noupx --name ed_lrr_gui ../ed_lrr_gui/__main__.py -pyinstaller --noupx --onefile --name ed_lrr_gui ../ed_lrr_gui/__main__.py -cd .. ``` -# Clean +then you can run `ed_lrr -h` from -```bash -rm -rfv _*.pyd *.pyc *.egg-info pip-wheel-metadata dist exe build __pycache__ -cd rust -cargo clean -cargo clean --release -cd .. -``` - -# TODO -- integrate callbacks into the GUI: WIP - - QTimer pulls from queue updates UI (every 100ms) +# To do +- Implement progress dialog for preprocessor +- Finish implementing Dialog to display the computed route \ No newline at end of file