Readme more readable, added virtualenv explanation.
This commit is contained in:
parent
33cc1cb564
commit
d9fdbc7279
|
@ -2,3 +2,4 @@
|
||||||
.idea/
|
.idea/
|
||||||
tests/tmp/
|
tests/tmp/
|
||||||
build/
|
build/
|
||||||
|
venv/
|
||||||
|
|
27
README.md
27
README.md
|
@ -1,15 +1,13 @@
|
||||||
FlatCAM BETA (c) 2019 - by Marius Stanciu
|
# FlatCAM BETA (c) 2019 - by Marius Stanciu
|
||||||
|
|
||||||
Based on FlatCAM:
|
Based on FlatCAM:
|
||||||
2D Computer-Aided PCB Manufacturing by (c) 2014-2016 Juan Pablo Caram
|
2D Computer-Aided PCB Manufacturing by (c) 2014-2016 Juan Pablo Caram
|
||||||
=====================================================================
|
|
||||||
|
|
||||||
FlatCAM is a program for preparing CNC jobs for making PCBs on a CNC router.
|
FlatCAM is a program for preparing CNC jobs for making PCBs on a CNC router.
|
||||||
Among other things, it can take a Gerber file generated by your favorite PCB
|
Among other things, it can take a Gerber file generated by your favorite PCB
|
||||||
CAD program, and create G-Code for Isolation routing.
|
CAD program, and create G-Code for Isolation routing.
|
||||||
|
|
||||||
=====================================================================
|
## Installation instructions
|
||||||
|
|
||||||
-------------------------- Installation instructions ----------------
|
|
||||||
|
|
||||||
Works with Python version 3.5 or greater and PyQt5.
|
Works with Python version 3.5 or greater and PyQt5.
|
||||||
More on the YouTube channel: https://www.youtube.com/playlist?list=PLVvP2SYRpx-AQgNlfoxw93tXUXon7G94_
|
More on the YouTube channel: https://www.youtube.com/playlist?list=PLVvP2SYRpx-AQgNlfoxw93tXUXon7G94_
|
||||||
|
@ -21,7 +19,20 @@ Menu -> Help -> About FlatCAM -> Programmers -> Marius Stanciu
|
||||||
- Download sources from: https://bitbucket.org/jpcgt/flatcam/downloads/
|
- Download sources from: https://bitbucket.org/jpcgt/flatcam/downloads/
|
||||||
- Unzip them on a HDD location that your user has permissions for.
|
- Unzip them on a HDD location that your user has permissions for.
|
||||||
|
|
||||||
1.Windows
|
### Linux Virtual Env
|
||||||
|
|
||||||
|
1. Clone this repository.
|
||||||
|
2. Install these packages from your distro's repository.
|
||||||
|
On Ubuntu:
|
||||||
|
`sudo apt install libfreetype6 libfreetype6-dev libgeos-dev libpng-dev libspatialindex-dev qt5-style-plugins python3-dev python3-gdal python3-pip python3-pyqt5 python3-pyqt5.qtopengl python3-simplejson python3-tk python3-virtualenv`
|
||||||
|
3. Create python virtual environment in repo's folder and activate it.
|
||||||
|
`virtualenv venv`
|
||||||
|
`source venv/bin/activate`
|
||||||
|
4. Install python requirements.
|
||||||
|
`pip3 install -r requirements.txt`
|
||||||
|
5. Now, FlatCAM can be launched with `launch.sh`.
|
||||||
|
|
||||||
|
#### Windows
|
||||||
|
|
||||||
- download the provided installer (for your OS flavor 64bit or 32bit) from:
|
- download the provided installer (for your OS flavor 64bit or 32bit) from:
|
||||||
https://bitbucket.org/jpcgt/flatcam/downloads/
|
https://bitbucket.org/jpcgt/flatcam/downloads/
|
||||||
|
@ -61,7 +72,7 @@ Run FlatCAM beta from the installation folder (e.g D:\FlatCAM_beta) in the Comma
|
||||||
cd D:\FlatCAM_beta
|
cd D:\FlatCAM_beta
|
||||||
python FlatCAM.py
|
python FlatCAM.py
|
||||||
|
|
||||||
2.Linux
|
#### Linux
|
||||||
|
|
||||||
- make sure that Python 3.8 is installed on your OS and that the command: python3 -V confirm it
|
- make sure that Python 3.8 is installed on your OS and that the command: python3 -V confirm it
|
||||||
- verify that the pip package is installed for your Python installation (e.g 3.8) by running the command:
|
- verify that the pip package is installed for your Python installation (e.g 3.8) by running the command:
|
||||||
|
@ -96,7 +107,7 @@ make install
|
||||||
sudo make install
|
sudo make install
|
||||||
```
|
```
|
||||||
|
|
||||||
3.MacOS
|
#### MacOS
|
||||||
|
|
||||||
Instructions from here: https://gist.github.com/natevw/3e6fc929aff358b38c0a#gistcomment-3111878
|
Instructions from here: https://gist.github.com/natevw/3e6fc929aff358b38c0a#gistcomment-3111878
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue