From a4cf31b104de1dea83b25a844cdc9bcc03f1a777 Mon Sep 17 00:00:00 2001 From: mkbel <35807926+mkbel@users.noreply.github.com> Date: Tue, 19 Feb 2019 23:57:24 +0100 Subject: [PATCH] Update README.md Reorder sections, update table of content, add notes and issue tracker link for Windows Linux subsystem and Git-bash builds. --- README.md | 109 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 57 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 5f560fc0a..798df4fa6 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ * [Linux build](#linux) - * [Windows build](#windows) + * Windows build + * [Using Arduino](#using-arduino) + * [Using Linux subsystem](#using-linux-subsystem-under-windows-10-64-bit) + * [Using Git-bash](#using-git-bash-under-windows-10-64-bit) * [Automated tests](#3-automated-tests) * [Documentation](#4-documentation) @@ -16,56 +19,9 @@ If you wish to flash from Arduino, follow step [2.c](#2c) from Windows build fir The script downloads Arduino with our modifications and Rambo board support installed, unpacks it into folder PF-build-env-\ on the same level, as your Prusa-Firmware folder is located, builds firmware for MK3 using that Arduino in Prusa-Firmware-build folder on the same level as Prusa-Firmware, runs secondary language support scripts. Firmware with secondary language support is generated in lang subfolder. Use firmware.hex for MK3 variant. Use firmware_\.hex for other printers. Don't forget to follow step [2.b](#2b) first for non-MK3 printers. ## Windows -### If you want to use the automated `PF-build.sh` you gonna need to install on you Windows a Linux subsystem or Git-bash - -### Steps for Linux subsystem und Windows 10 64-bit: -- follow the Microsoft guide https://docs.microsoft.com/en-us/windows/wsl/install-win10 - You can also use the 'prepare_winbuild.ps1' powershell script with Administrator rights -- Tested versions are at this moment - - Ubuntu other may different - - After the installation and reboot please open your Ubuntu bash and do following steps - - run command `apt-get update` - - to install zip run `apt-get install zip` - - add few lines at the top of `~/.bashrc` by running `sudo nano ~/.bashrc` - - export OS="Linux" - export JAVA_TOOL_OPTIONS="-Djava.net.preferIPv4Stack=true" - export GPG_TTY=$(tty) - - use `CRTL-X` to close nano and confirm to write the new entries - - restart Ubuntu bash -Now your Ubuntu subsystem is ready to use the automatic `PF-build.sh` script and compile your firmware correctly - -#### Some Tips for Ubuntu -- Linux is case sensetive so please don't forget to use capital letters where needed, like changing to a directory -- To change the path to your Prusa-Firmware location you downloaded and unzipped - - Example: You files are under `C:\Users\\Downloads\Prusa-Firmware-MK3` - - use under Ubuntu the following command `cd /mnt/c/Users//Downloads/Prusa-Firmware-MK3` - to change to the right folder - -#### Compile Prusa-firmware with Ubuntu Linux subsystem installed -- open Ubuntu bash -- change to your source code folder (case sensitive) -- run `./PF-build.sh` -- follow the instructions - -### Steps for Git-bash under Windows 10 64-bit: -- Download and install the 64bit Git version https://git-scm.com/download/win -- Also follow these instructions https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058 -- Download and install 7z-zip from its official website https://www.7-zip.org/ - By default, it is installed under the directory /c/Program Files/7-Zip in Windows 10 -- Run `Git-Bash` under Administrator privilege -- navigate to the directory /c/Program Files/Git/mingw64/bin -- run `ln -s /c/Program Files/7-Zip/7z.exe zip.exe` - -#### Compile Prusa-firmware with Git-bash installed -- open Git-bash -- change to your source code folder -- run `bash PF-build.sh` -- follow the instructions - - -### 1. Development environment preparation +### Using Arduino +note: Multi language build is not supported. +#### 1. Development environment preparation a. install `"Arduino Software IDE"` for your preferred operating system `https://www.arduino.cc -> Software->Downloads` @@ -97,7 +53,7 @@ add "-Wl,-u,vfprintf -lprintf_flt -lm" to "compiler.c.elf.flags=" before existin example: `"compiler.c.elf.flags=-w -Os -Wl,-u,vfprintf -lprintf_flt -lm -Wl,--gc-sections"` -### 2. Source code compilation +#### 2. Source code compilation a. place the source codes corresponding to your printer model obtained from the repository into the selected directory on your disk `https://github.com/prusa3d/Prusa-Firmware/` @@ -125,6 +81,55 @@ or you can also save the output code to the file (in so called `HEX`-format) `"F and then upload it to the printer using the program `"FirmwareUpdater"` _note: this file is created in the directory `"Firmware/"`_ +### Using Linux subsystem under Windows 10 64-bit +_notes: Script and instructions contributed by 3d-gussner. Use at your own risk. Script downloads Arduino executables outside of Prusa control. Report problems [there.](https://github.com/3d-gussner/Prusa-Firmware/issues) Multi language build is supported._ +- follow the Microsoft guide https://docs.microsoft.com/en-us/windows/wsl/install-win10 + You can also use the 'prepare_winbuild.ps1' powershell script with Administrator rights +- Tested versions are at this moment + - Ubuntu other may different + - After the installation and reboot please open your Ubuntu bash and do following steps + - run command `apt-get update` + - to install zip run `apt-get install zip` + - add few lines at the top of `~/.bashrc` by running `sudo nano ~/.bashrc` + + export OS="Linux" + export JAVA_TOOL_OPTIONS="-Djava.net.preferIPv4Stack=true" + export GPG_TTY=$(tty) + + use `CRTL-X` to close nano and confirm to write the new entries + - restart Ubuntu bash +Now your Ubuntu subsystem is ready to use the automatic `PF-build.sh` script and compile your firmware correctly + +#### Some Tips for Ubuntu +- Linux is case sensetive so please don't forget to use capital letters where needed, like changing to a directory +- To change the path to your Prusa-Firmware location you downloaded and unzipped + - Example: You files are under `C:\Users\\Downloads\Prusa-Firmware-MK3` + - use under Ubuntu the following command `cd /mnt/c/Users//Downloads/Prusa-Firmware-MK3` + to change to the right folder + +#### Compile Prusa-firmware with Ubuntu Linux subsystem installed +- open Ubuntu bash +- change to your source code folder (case sensitive) +- run `./PF-build.sh` +- follow the instructions + +### Using Git-bash under Windows 10 64-bit +_notes: Script and instructions contributed by 3d-gussner. Use at your own risk. Script downloads Arduino executables outside of Prusa control. Report problems [there.](https://github.com/3d-gussner/Prusa-Firmware/issues) Multi language build is supported._ +- Download and install the 64bit Git version https://git-scm.com/download/win +- Also follow these instructions https://gist.github.com/evanwill/0207876c3243bbb6863e65ec5dc3f058 +- Download and install 7z-zip from its official website https://www.7-zip.org/ + By default, it is installed under the directory /c/Program Files/7-Zip in Windows 10 +- Run `Git-Bash` under Administrator privilege +- navigate to the directory /c/Program Files/Git/mingw64/bin +- run `ln -s /c/Program Files/7-Zip/7z.exe zip.exe` + +#### Compile Prusa-firmware with Git-bash installed +- open Git-bash +- change to your source code folder +- run `bash PF-build.sh` +- follow the instructions + + # 3. Automated tests ## Prerequisites c++11 compiler e.g. g++ 6.3.1