Make README file markdown

[proxmark3-svn] / README.md

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..7258f91
--- /dev/null
+++ b/README.md
@@ -0,0 +1,74 @@
+# proxmark3: the official Proxmark repository!
+
+The proxmark3 is a powerful general purpose RFID tool, the size of a deck
+of cards, designed to snoop, listen and emulate everything from
+**Low Frequency (125kHz)** to **High Frequency (13.56MHz)** tags.
+
+This repository contains enough software, logic (for the FPGA), and design
+documentation for the hardware that you could, at least in theory,
+do something useful with a proxmark3.
+
+## Resources
+
+* [This repository!](https://github.com/Proxmark/proxmark3)
+* [The Wiki](https://github.com/Proxmark/proxmark3/wiki)
+* [The GitHub Pages website](http://proxmark.github.io/proxmark3/)
+* [The Forum](http://www.proxmark.org/forum)
+* The IRC channel: irc.freenode.org #proxmark3 ([chat in your browser](http://webchat.freenode.net/?channels=#proxmark3))
+* [The Homebrew formula repository](https://github.com/Proxmark/homebrew-proxmark3)
+   
+## Development
+
+The tools required to build  or run the project will vary depending on
+your operating system. Please refer to [the wiki](https://github.com/Proxmark/proxmark3/wiki) for details.
+
+## Obtaining hardware
+
+The Proxmark3 is available for purchase (assembled and tested) from the
+following locations:
+
+* [RyscCorp](https://proxmark3.com/) (US)
+* [Elechouse](http://www.elechouse.com/) (HK)
+* [Lab401](https://lab401.com/) (FR)
+* [RFxSecure](http://www.rfxsecure.com/) (SG)
+* [IceSQL](http://proxmark3.tictail.com/) (SE)
+   
+Most of the ultra-low-volume contract assemblers could put
+something like this together with a reasonable yield. A run of around
+a dozen units is probably cost-effective. The BOM includes (possibly-
+outdated) component pricing, and everything is available from Digikey
+and the usual distributors.
+
+If you've never assembled a modern circuit board by hand, then this is
+not a good place to start. Some of the components (e.g. the crystals)
+must not be assembled with a soldering iron, and require hot air.
+
+The schematics are included; the component values given are not
+necessarily correct for all situations, but it should be possible to do
+nearly anything you would want with appropriate population options.
+
+The printed circuit board artwork is also available, as Gerbers and an
+Excellon drill file.
+
+
+## License
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Jonathan Westhues
+user jwesthues, at host cq.cx
+
+May 2007, Cambridge MA