summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDaveHodder67 <dave.hodder@focusrite.com>2015-07-03 17:15:00 +0100
committerDaveHodder67 <dave.hodder@focusrite.com>2015-07-03 17:15:00 +0100
commit0490d1460a3c45d02090e59e6498471b68987f2c (patch)
tree0677e3350b71158d7f3d68743ffa330ff1e34493 /README.md
parent2cf825e058b4626264ac9d4671e9e225b7797f38 (diff)
downloadlaunchpad-polymaker-0490d1460a3c45d02090e59e6498471b68987f2c.tar.gz
launchpad-polymaker-0490d1460a3c45d02090e59e6498471b68987f2c.zip
improved README
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 18 insertions, 8 deletions
diff --git a/README.md b/README.md
index 64bf557..15f3ac6 100644
--- a/README.md
+++ b/README.md
@@ -27,7 +27,9 @@ This project uses [Vagrant](https://www.vagrantup.com/) to manage the build envi
272. Install [Vagrant](https://www.vagrantup.com/) 272. Install [Vagrant](https://www.vagrantup.com/)
283. Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads) 283. Install [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
294. Open a command prompt, and navigate to the project directory 294. Open a command prompt, and navigate to the project directory
305. Type `vagrant up`, hit enter and grab a beverage of your choice. It's building a lovely fresh development machine just for you! 305. 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
32Note 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
33Once 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. 35Once 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
411. Log in to the Ubuntu GUI (the password is, as is the convention, "vagrant"). 43Make 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
451. Log in to the Ubuntu GUI (the password is, as is the convention, **vagrant**).
422. Launch Eclipse from the doodah on the top left (it's a bit like Spotlight) 462. Launch Eclipse from the doodah on the top left (it's a bit like Spotlight)
433. 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. 473. 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.
444. In Eclipse, choose "File->Import..." 484. Click "Workbench" at the Ecliplse startup screen.
455. Under "C/C++", choose "Existing Code as Makefile Project", hit "Next" 495. In Eclipse, choose "File->Import..."
466. Give the project any name you like (launchpad?) 506. Under "C/C++", choose "Existing Code as Makefile Project", hit "Next"
477. Under "Existing Code Location" type `/vagrant` 517. Give the project any name you like (launchpad?)
488. Hit Finish - you should now see your project. If not, click "Workbench" and it should appear. 528. Under "Existing Code Location" type `/vagrant`. The toolchain isn't important, the compiler is part of the Makefile.
499. Click the hammer icon at the top, and wait while the project builds. 539. Hit Finish - you should now see your project.
5410. Select your project by clicking on it.
5511. Click the hammer icon at the top, and wait while the project builds.
50 56
51Either 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! 57Either 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
95If 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/). 101If 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
105It appears that VirtualBox does not yet work on Windows 10.
106