Merge branch 'master' into fix_iclass_sim
[proxmark3-svn] / README.md
CommitLineData
1ccdd4f6 1# proxmark3: the official Proxmark repository!
770f7345 2
b27c1909
W
3The proxmark3 is a powerful general purpose RFID tool, the size of a deck
4of cards, designed to snoop, listen and emulate everything from
1ccdd4f6 5**Low Frequency (125kHz)** to **High Frequency (13.56MHz)** tags.
770f7345 6
b27c1909
W
7This repository contains enough software, logic (for the FPGA), and design
8documentation for the hardware that you could, at least in theory,
9do something useful with a proxmark3.
10
1ccdd4f6
QP
11## Resources
12
13* [This repository!](https://github.com/Proxmark/proxmark3)
14* [The Wiki](https://github.com/Proxmark/proxmark3/wiki)
15* [The GitHub Pages website](http://proxmark.github.io/proxmark3/)
16* [The Forum](http://www.proxmark.org/forum)
17* The IRC channel: irc.freenode.org #proxmark3 ([chat in your browser](http://webchat.freenode.net/?channels=#proxmark3))
18* [The Homebrew formula repository](https://github.com/Proxmark/homebrew-proxmark3)
b27c1909 19
1ccdd4f6 20## Development
b27c1909
W
21
22The tools required to build or run the project will vary depending on
1ccdd4f6 23your operating system. Please refer to [the wiki](https://github.com/Proxmark/proxmark3/wiki) for details.
770f7345 24
1ccdd4f6 25## Obtaining hardware
770f7345 26
3e7df262 27The Proxmark3 is available for purchase (assembled and tested) from the
b27c1909 28following locations:
770f7345 29
1ccdd4f6 30* [RyscCorp](https://proxmark3.com/) (US)
d4d439a8 31* [Hackerwarehouse](https://hackerwarehouse.com/) (US)
1ccdd4f6 32* [Elechouse](http://www.elechouse.com/) (HK)
9ebbfd89 33* [Lab401](https://lab401.com/) (HK)
1ccdd4f6 34* [RFxSecure](http://www.rfxsecure.com/) (SG)
9ebbfd89
I
35* [Sneaktechnology](https://www.sneaktechnology.com/) (ASIA/OCEANIA)
36
3e7df262 37
b27c1909 38Most of the ultra-low-volume contract assemblers could put
770f7345 39something like this together with a reasonable yield. A run of around
40a dozen units is probably cost-effective. The BOM includes (possibly-
41outdated) component pricing, and everything is available from Digikey
42and the usual distributors.
43
44If you've never assembled a modern circuit board by hand, then this is
45not a good place to start. Some of the components (e.g. the crystals)
46must not be assembled with a soldering iron, and require hot air.
47
48The schematics are included; the component values given are not
49necessarily correct for all situations, but it should be possible to do
50nearly anything you would want with appropriate population options.
51
52The printed circuit board artwork is also available, as Gerbers and an
53Excellon drill file.
54
55
1ccdd4f6 56## License
770f7345 57
58This program is free software; you can redistribute it and/or modify
59it under the terms of the GNU General Public License as published by
60the Free Software Foundation; either version 2 of the License, or
61(at your option) any later version.
62
63This program is distributed in the hope that it will be useful,
64but WITHOUT ANY WARRANTY; without even the implied warranty of
65MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
66GNU General Public License for more details.
67
68You should have received a copy of the GNU General Public License
69along with this program; if not, write to the Free Software
70Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
71
72
73Jonathan Westhues
74user jwesthues, at host cq.cx
75
76May 2007, Cambridge MA
Impressum, Datenschutz