diff --git a/buildinstructions.md b/buildinstructions.md new file mode 100644 index 000000000..717c8bd22 --- /dev/null +++ b/buildinstructions.md @@ -0,0 +1,93 @@ +# Build instructions +In general please follow the build instructions as described in [readme.md](readme.md). Here you will find a brief overview about what is needed to build your own development environment without further explanations. +## Setup on OS X +### Prerequisites +* install python 3.10 +* install python extension compile environment, this is automatically done if you have xcode +* install git +### Clone the repository +``` +git clone http://github.com/kliment/Printrun.git +cd Printrun +git pull +``` +### Install and activate the virtual environment +``` +python3 -m venv v3 +. ./v3/bin/activate +``` +### Install and update all required libraries +``` +pip install --upgrade pip +pip install --upgrade setuptools +pip install -r requirements.txt +pip install cython +python setup.py build_ext --inplace +``` + +### For running +`python pronterface.py` + +### For packaging +``` +pip install pyinstaller +pyi-makespec --hidden-import="pkg_resources.py2_warn" -F --add-data images/\*:images --add-data \*.png:. --add-data \*.ico:. -w -i P-face.icns pronterface.py +rm -rf dist +sed -i '' '$ s/.$//' pronterface.spec +cat >> pronterface.spec <[!TIP] Please find further informations about building a development environment and packaging in script [release_windows.bat](release_windows.bat) where we implemented an automated build for windows. + +### Remark: +>[^1] The library **polygon3** is free for non commercial use. You can build Pronterface without this library - but then it will run slower. +>Please find further details regarding license here: https://pypi.org/project/Polygon3/ \ No newline at end of file diff --git a/buildinstructions.txt b/buildinstructions.txt deleted file mode 100644 index 30d01f7cf..000000000 --- a/buildinstructions.txt +++ /dev/null @@ -1,68 +0,0 @@ -setup on osx: -(install python 3.10) -(install python extension compile environment, this is automatically done if you have xcode) -(install git) -git clone http://github.com/kliment/Printrun.git -cd Printrun -git pull -python3 -m venv v3 -. ./v3/bin/activate -pip install --upgrade pip -pip install --upgrade setuptools -pip install -r requirements.txt -pip install cython -python setup.py build_ext --inplace - -for running: -python pronterface.py - -for packaging: -pip install pyinstaller -pyi-makespec --hidden-import="pkg_resources.py2_warn" -F --add-data images/\*:images --add-data \*.png:. --add-data \*.ico:. -w -i P-face.icns pronterface.py -rm -rf dist -sed -i '' '$ s/.$//' pronterface.spec -cat >> pronterface.spec <