From: Fletcher T. Penney Date: Sat, 21 Jan 2017 21:44:13 +0000 (-0500) Subject: NOTE: Refactor build instructions to single document X-Git-Tag: 0.1.1a^2~18 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=97037243e5bc5ed6f17a8eda902517d5fa0a3e33;p=multimarkdown NOTE: Refactor build instructions to single document --- diff --git a/BUILD.md b/BUILD.md deleted file mode 100644 index f276371..0000000 --- a/BUILD.md +++ /dev/null @@ -1,14 +0,0 @@ -1. Download source using git: - - git clone https://github.com/fletcher/MultiMarkdown-6.git - - or web: - - https://github.com/fletcher/MultiMarkdown-6 - -2. Compile, and (optionally) test: - - make - cd build - make - make test diff --git a/IMPORTANT b/IMPORTANT index fe1b6af..4b52551 100644 --- a/IMPORTANT +++ b/IMPORTANT @@ -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: @@ -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