summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGilles Peskine <Gilles.Peskine@arm.com>2017-06-16 14:52:39 +0200
committerSimon Butcher <simon.butcher@arm.com>2017-10-03 22:21:33 +0100
commit82759aa1c7d59e074eb9e2a0d28ca2a6b3ffb0fc (patch)
tree3013a1e2a36e17196eb0d7afa20dcd3c59d5d610 /README.md
parent967a60502e02fddd587ada912842d82c7505757f (diff)
Note in README that GNU make is required
Our README claims that we only use basic Make functionality, but in fact GNU make is required for conditional compilation. Document this. Addresses issue #967
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/README.md b/README.md
index 11b4ebf6..624e03fe 100644
--- a/README.md
+++ b/README.md
@@ -14,11 +14,11 @@ Compiling
There are currently four active build systems used within mbed TLS releases:
- yotta
-- Make
+- GNU Make
- CMake
- Microsoft Visual Studio (Visual Studio 6 and Visual Studio 2010)
-The main systems used for development are CMake and Make. Those systems are always complete and up-to-date. The others should reflect all changes present in the CMake and Make build system, although features may not be ported there automatically.
+The main systems used for development are CMake and GNU Make. Those systems are always complete and up-to-date. The others should reflect all changes present in the CMake and Make build system, although features may not be ported there automatically.
Yotta, as a build system, is slightly different from the other build systems:
@@ -54,9 +54,9 @@ For more details on the yotta/mbed OS edition of mbed TLS, including example pro
### Make
-We intentionally only use the minimum of `Make` functionality, as a lot of `Make` features are not supported on all different implementations of Make or on different platforms. As such, the Makefiles sometimes require some manual changes or export statements in order to work for your platform.
+We require GNU Make. To build the library and the sample programs, GNU Make and a C compiler are sufficient. Some of the more advanced build targets require some Unix/Linux tools.
-In order to build from the source code using Make, just enter at the command line:
+In order to build from the source code using GNU Make, just enter at the command line:
make