diff --git a/.gitignore b/.gitignore index a9ab476f0..66072cd2f 100644 --- a/.gitignore +++ b/.gitignore @@ -23,7 +23,6 @@ libtool.m4 aclocal.m4 aminclude.am lt*.m4 -INSTALL Makefile.in Makefile depcomp diff --git a/INSTALL b/INSTALL new file mode 100644 index 000000000..b9249c0e5 --- /dev/null +++ b/INSTALL @@ -0,0 +1,45 @@ +0. Building on *nix from git repository + + Run the autogen script to generate configure, you'll need the autoconf tools + installed, then proceed to step 1. + + $ ./autogen.sh + +1. Building on *nix from a release + + $ ./configure + $ make + $ make check # (optional, but highly recommended) + $ sudo make install + +2. Building on iOS + + Use on the xcode project in IDE/iOS/wolfssl.xcodeproj + There is a README in IDE/iOS with more information + +3. Building on Windows + + Use the 32bit Visual Studio Solution wolfssl.sln + For a 64bit solution please use wolfssl64.sln + +4. Building with IAR + + Please see the README in IDE/IAR-EWARM for detailed instructions + +5. Building with Keil + + Please see the Keil Projects in IDE/MDK5-ARM/Projects + +6. Building with Microchip tools + + Please see the README in mplabx + +7. Building with Freescale MQX + + Please see the README in mqx + +8. Porting to a new platform + + Please see section 2.4 in the manual: + http://www.wolfssl.com/yaSSL/Docs-cyassl-manual-2-building-cyassl.html + diff --git a/Makefile.am b/Makefile.am index 43ae1caaa..860067122 100644 --- a/Makefile.am +++ b/Makefile.am @@ -58,6 +58,7 @@ EXTRA_DIST+= gencertbuf.pl EXTRA_DIST+= IDE EXTRA_DIST+= README.md EXTRA_DIST+= LICENSING +EXTRA_DIST+= INSTALL include cyassl/include.am include wolfssl/include.am