From f026091627610f05283f7dbe2a8c435ee1a4629b Mon Sep 17 00:00:00 2001
From: Samuel Sadok <samuel.sadok@bluewin.ch>
Date: Mon, 12 Mar 2018 22:28:14 -0700
Subject: [PATCH] make Firmware the toplevel directory of tup

---
 .gitignore                                        | 2 +-
 .travis.yml                                       | 3 ++-
 Firmware/CHANGELOG.md                             | 1 +
 Firmware/README.md                                | 2 +-
 Tupfile.ini => Firmware/Tupfile.ini               | 0
 tup.config.default => Firmware/tup.config.default | 0
 6 files changed, 5 insertions(+), 3 deletions(-)
 rename Tupfile.ini => Firmware/Tupfile.ini (100%)
 rename tup.config.default => Firmware/tup.config.default (100%)

diff --git a/.gitignore b/.gitignore
index 4f7e8430..4a8546b5 100644
--- a/.gitignore
+++ b/.gitignore
@@ -63,4 +63,4 @@ target/
 
 # Tup
 .tup
-/tup.config
+tup.config
diff --git a/.travis.yml b/.travis.yml
index acc62f3d..f8117391 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -30,7 +30,8 @@ install:
   - export PATH=$PATH:$TUP_DIR/usr/bin
 
 script:
-  - mkdir -p Firmware/build
+  - cd Firmware
+  - mkdir -p build
   - echo "CONFIG_BOARD_VERSION=v3.4-24V" > tup.config # TODO: build more configuration combinations
   - tup generate ./build.sh
   - bash -xe ./build.sh
diff --git a/Firmware/CHANGELOG.md b/Firmware/CHANGELOG.md
index 2b4fe92d..7669ad56 100644
--- a/Firmware/CHANGELOG.md
+++ b/Firmware/CHANGELOG.md
@@ -6,6 +6,7 @@ Please add a note of your changes below this heading if you make a Pull Request.
 
 ### Changed
 * The build is now configured using the `tup.config` file instead of editing source files. Make sure you set your board version correctly. See [here](README.md#configuring-the-build) for details.
+* The toplevel directory for tup is now `Firmware`. If you used tup before, go to `Firmware` and run `rm -rd ../.tup; rm -rd build/*; make`.
 
 # Releases
 
diff --git a/Firmware/README.md b/Firmware/README.md
index 18feb9cd..d32cd2fe 100644
--- a/Firmware/README.md
+++ b/Firmware/README.md
@@ -27,7 +27,7 @@ The project is under active development, so make sure to check the [Changelog](C
 To correctly operate the ODrive, you need to supply some parameters. Some are mandatory, and if supplied incorrectly will cause the drive to malfunction.
 In this section we will set the compile-time parameters, later we will also set the [run time parameters](#configuring-parameters).
 
-To customize the compile time parameters, copy or rename the file `tup.config.default` to `tup.config` and edit the parameters in that file:
+To customize the compile time parameters, copy or rename the file `Firmware/tup.config.default` to `Firmware/tup.config` and edit the parameters in that file:
 
 __CONFIG_BOARD_VERSION__: The board version you're using. Can be `v3.1`, `v3.2`, `v3.3`, `v3.4-24V` or `v3.4-48V`. Check for a label on the upper side of the ODrive to find out which version you have.
 
diff --git a/Tupfile.ini b/Firmware/Tupfile.ini
similarity index 100%
rename from Tupfile.ini
rename to Firmware/Tupfile.ini
diff --git a/tup.config.default b/Firmware/tup.config.default
similarity index 100%
rename from tup.config.default
rename to Firmware/tup.config.default