Initial commit for the firmware. Used the 20090306_ela version as baseline.

[proxmark3-svn] / doc / README.TXT

diff --git a/doc/README.TXT b/doc/README.TXT
new file mode 100644 (file)
index 0000000..f3b49c7
--- /dev/null
+++ b/doc/README.TXT
@@ -0,0 +1,39 @@
+This is a bare minimum compile environment for the proxmark3 sources. \r
+\r
+CONTENTS\r
+\r
+This bundle contains the ARM cross compiler in devkitARM and a _tiny_ subset\r
+of the Visual C++ 2008 Express Edition in devkitWIN which is the bare minimum\r
+required for compilation of this current source.\r
+\r
+If you plan on further source code development you are strongly encouraged\r
+to download the full Visual C++ 2008 available for free download from\r
+http://www.microsoft.com/express/download/\r
+\r
+CAVEATS\r
+\r
+There is no provision in this environment for compiling the FPGA source. To\r
+do that you need to download the free (registration required) ISE WebPack\r
+from Xilinx at http://www.xilinx.com/ise/logic_design_prod/webpack.htm\r
+Be warned, the pack is huge, 2Gb download and >4Gb installed.\r
+\r
+USAGE\r
+\r
+First of all run the .msi file in devkitWIN\vcredist_x86 to install the VC++\r
+redistributables, without these, nmake, cl and link won't run.\r
+\r
+Get a command prompts in the cockpit directory and pretty much run the batch\r
+files in the order they appear:\r
+\r
+0setpath.bat  - sets the environment vars for the compile environment\r
+1makearm.bat  - compiles the files in armsrc, output files in armsrc\obj\r
+2makeboot.bat - compiles the files in bootrom, output files in bootrom\obj\r
+3makewin.bat  - compiles the files in winsrc, output files in winsrc\obj\r
+4flashos.bat  - attempts to upload the OS image to the proxmark3 board\r
+\r
+ACKNOWLEDGMENTS\r
+\r
+Thanks to J Westhues for the original proxmark, Roel and the proxmark.org\r
+community. This pack may contain F/OSS or free but copyrighted software\r
+from Xilinx, Microsoft and others. All trademarks are the property of\r
+their respective owners. All rights reserved.\r