diff options
author | DaveHodder67 <dave.hodder@focusrite.com> | 2015-07-03 17:15:00 +0100 |
---|---|---|
committer | DaveHodder67 <dave.hodder@focusrite.com> | 2015-07-03 17:15:00 +0100 |
commit | 0490d1460a3c45d02090e59e6498471b68987f2c (patch) | |
tree | 0677e3350b71158d7f3d68743ffa330ff1e34493 | |
parent | 2cf825e058b4626264ac9d4671e9e225b7797f38 (diff) | |
download | launchpad-polymaker-0490d1460a3c45d02090e59e6498471b68987f2c.tar.gz launchpad-polymaker-0490d1460a3c45d02090e59e6498471b68987f2c.zip |
improved README
-rw-r--r-- | README.md | 26 |
1 files changed, 18 insertions, 8 deletions
@@ -27,7 +27,9 @@ This project uses [Vagrant](https://www.vagrantup.com/) to manage the build envi | |||
27 | 2. Install [Vagrant](https://www.vagrantup.com/) | 27 | 2. Install [Vagrant](https://www.vagrantup.com/) |
28 | 3. Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) | 28 | 3. Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) |
29 | 4. Open a command prompt, and navigate to the project directory | 29 | 4. Open a command prompt, and navigate to the project directory |
30 | 5. Type `vagrant up`, hit enter and grab a beverage of your choice. It's building a lovely fresh development machine just for you! | 30 | 5. Type `vagrant up`, hit enter and grab a beverage of your choice. Maybe two - it is building a lovely fresh development machine just for you! |
31 | |||
32 | Note that it does take quite a while to download everything. If you have a poor internet connection, ummm, find a better one :) | ||
31 | 33 | ||
32 | # Building | 34 | # Building |
33 | Once your new "box" is up and running, you can build the app in one of two ways. In the spirit of experimentation, we've created a full Eclipse development environment for you to use. However, you might prefer to do things on the command line. | 35 | Once your new "box" is up and running, you can build the app in one of two ways. In the spirit of experimentation, we've created a full Eclipse development environment for you to use. However, you might prefer to do things on the command line. |
@@ -38,15 +40,19 @@ Once your new "box" is up and running, you can build the app in one of two ways. | |||
38 | 40 | ||
39 | # To build using the Eclipse GUI | 41 | # To build using the Eclipse GUI |
40 | 42 | ||
41 | 1. Log in to the Ubuntu GUI (the password is, as is the convention, "vagrant"). | 43 | Make sure you wait until the `vagrant up` command has completed before logging in to your VM. The GUI appears long before the provisioning script finishes. |
44 | |||
45 | 1. Log in to the Ubuntu GUI (the password is, as is the convention, **vagrant**). | ||
42 | 2. Launch Eclipse from the doodah on the top left (it's a bit like Spotlight) | 46 | 2. Launch Eclipse from the doodah on the top left (it's a bit like Spotlight) |
43 | 3. Accept the default when Eclipse asks you for a workspace. I can't figure out how to store the workspace in source control, so you need to import it. | 47 | 3. Accept the default when Eclipse asks you for a workspace. I can't figure out how to store the workspace in source control, so you need to import it. |
44 | 4. In Eclipse, choose "File->Import..." | 48 | 4. Click "Workbench" at the Ecliplse startup screen. |
45 | 5. Under "C/C++", choose "Existing Code as Makefile Project", hit "Next" | 49 | 5. In Eclipse, choose "File->Import..." |
46 | 6. Give the project any name you like (launchpad?) | 50 | 6. Under "C/C++", choose "Existing Code as Makefile Project", hit "Next" |
47 | 7. Under "Existing Code Location" type `/vagrant` | 51 | 7. Give the project any name you like (launchpad?) |
48 | 8. Hit Finish - you should now see your project. If not, click "Workbench" and it should appear. | 52 | 8. Under "Existing Code Location" type `/vagrant`. The toolchain isn't important, the compiler is part of the Makefile. |
49 | 9. Click the hammer icon at the top, and wait while the project builds. | 53 | 9. Hit Finish - you should now see your project. |
54 | 10. Select your project by clicking on it. | ||
55 | 11. Click the hammer icon at the top, and wait while the project builds. | ||
50 | 56 | ||
51 | Either of the above methods will generate the firmware image, `launchpad_pro.syx`, in the project /build directory. You can then upload this to your Launchpad Pro from the host! | 57 | Either of the above methods will generate the firmware image, `launchpad_pro.syx`, in the project /build directory. You can then upload this to your Launchpad Pro from the host! |
52 | 58 | ||
@@ -94,3 +100,7 @@ If you only want to build using the command line, you might want to run your Vag | |||
94 | 100 | ||
95 | If prefer, you can install the gcc-arm toolchain on your local machine, or you might already have it. You can find all you need [here](http://gnuarmeclipse.livius.net/). | 101 | If prefer, you can install the gcc-arm toolchain on your local machine, or you might already have it. You can find all you need [here](http://gnuarmeclipse.livius.net/). |
96 | 102 | ||
103 | |||
104 | |||
105 | It appears that VirtualBox does not yet work on Windows 10. | ||
106 | |||