Skip to content

Changes

Page history
Update Build setup authored by Jaco's avatar Jaco
Show whitespace changes
Inline Side-by-side
Build-setup.md
View page @ 2f8156e6
...@@ -40,6 +40,9 @@ Instructions for building on macOS. You should use either [Homebrew](https://bre ...@@ -40,6 +40,9 @@ Instructions for building on macOS. You should use either [Homebrew](https://bre
`brew install doxygen`<br /> `brew install doxygen`<br />
`python3 -m pip install Sphinx breathe furo` `python3 -m pip install Sphinx breathe furo`
1. [Install xquartz](https://www.xquartz.org/)
### For MacPorts ### For MacPorts
1. [Follow the instructions](https://www.macports.org) to install MacPorts. 1. [Follow the instructions](https://www.macports.org) to install MacPorts.
1. Update MacPorts:<br /> 1. Update MacPorts:<br />
...@@ -60,6 +63,9 @@ Instructions for building on macOS. You should use either [Homebrew](https://bre ...@@ -60,6 +63,9 @@ Instructions for building on macOS. You should use either [Homebrew](https://bre
`sudo port install md5sha1sum`<br /> `sudo port install md5sha1sum`<br />
`sudo port install findutils` `sudo port install findutils`
1. [Install xquartz](https://www.xquartz.org/)
## Windows ## Windows
Instructions for building on Windows 10. You can copy and paste the commands from here to the MSYS2 window. To paste in the MSYS2 window, right-click and select "Paste". Instructions for building on Windows 10. You can copy and paste the commands from here to the MSYS2 window. To paste in the MSYS2 window, right-click and select "Paste".
...@@ -89,9 +95,7 @@ and accept all defaults (press return) ...@@ -89,9 +95,7 @@ and accept all defaults (press return)
`pip install furo` `pip install furo`
## Common steps ## Common steps
1. [Install xquartz](https://www.xquartz.org/) 1. You will need to have an SSH key to connect to GitLab. If you already have created, skip this step.
1. I~~f you want to submit any (code or documentation) changes to the WP43 project, ~~You will need to have an SSH key to connect to GitLab. If you already have created, skip this step.
- Run `ssh-keygen -t rsa -b 4096` and accept all defaults (there is no need for a passphrase, so just press return) - Run `ssh-keygen -t rsa -b 4096` and accept all defaults (there is no need for a passphrase, so just press return)
1. Add the key to your GitLab account (which you should create if you don't have one) 1. Add the key to your GitLab account (which you should create if you don't have one)
1. Copy the key you just created. To do this type `cat ~/.ssh/id_rsa.pub` and then select the text produced from running this using your mouse. Then right click and select "Copy". Take care to include the ssh-rsa and exclude the command prompt that is visible at the bottom of the file 1. Copy the key you just created. To do this type `cat ~/.ssh/id_rsa.pub` and then select the text produced from running this using your mouse. Then right click and select "Copy". Take care to include the ssh-rsa and exclude the command prompt that is visible at the bottom of the file
...@@ -114,6 +118,13 @@ and accept all defaults (press return) ...@@ -114,6 +118,13 @@ and accept all defaults (press return)
`./wp43` (Linux, macOS) or `./wp43.exe` (Windows) `./wp43` (Linux, macOS) or `./wp43.exe` (Windows)
`./wp43 --landscape` or `./wp43.exe --landscape` runs the simulator in landscape mode `./wp43 --landscape` or `./wp43.exe --landscape` runs the simulator in landscape mode
### Updating the simulator
1. From the terminal run `git fetch`
1. From the terminal run `git reset --hard HEAD` to abandon all previous temporary files and edits
1. From the terminal run git checkout `origin/master`
### Building the DMCP firmware ### Building the DMCP firmware
This requires the appropriate DMCP firmware packages to be installed (see the section for your operating system). This requires the appropriate DMCP firmware packages to be installed (see the section for your operating system).
1. Build the source: <br /> 1. Build the source: <br />
......