Skip to content

Commit

Permalink
NOTE: Refactor build instructions to single document
Browse files Browse the repository at this point in the history
  • Loading branch information
fletcher committed Jan 21, 2017
1 parent 7279e4f commit 9703724
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 14 deletions.
14 changes: 0 additions & 14 deletions BUILD.md

This file was deleted.

10 changes: 10 additions & 0 deletions IMPORTANT
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
# Short Version #

Run `make` command from top directory, then change to the build directory and
run `make` again.


# Detailed Version #

This project is designed for use with cmake.

The Makefile controls the overall build:
Expand Down Expand Up @@ -32,6 +40,8 @@ These commands control the `build` directory. Everything in this directory is
auto-generated. You should not manually change these files or put anything
else in there.

From within the `build` directory, you can run `make` again to actually
compile the softeare.

The setup is designed to support unit testing with CuTest. Functions along
the lines of `void Test*` will be located automatically and used to create the
Expand Down

0 comments on commit 9703724

Please sign in to comment.