Merge pull request #969 from pwpiwi/gcc10_fixes
[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)
e6158a48 19* [Proxmark3 community discord server](https://discord.gg/86VcRtS)
b27c1909 20
1ccdd4f6 21## Development
b27c1909
W
22
23The tools required to build or run the project will vary depending on
1ccdd4f6 24your operating system. Please refer to [the wiki](https://github.com/Proxmark/proxmark3/wiki) for details.
770f7345 25
1ccdd4f6 26## Obtaining hardware
770f7345 27
3e7df262 28The Proxmark3 is available for purchase (assembled and tested) from the
b27c1909 29following locations:
770f7345 30
5eacacfd 31| Distributor Name | Warehouse Location | Entity Location |
32|------------------|--------------------|-----------------|
33| [RyscCorp](https://proxmark3.com/) | USA | USA |
34| [Hackerwarehouse](https://hackerwarehouse.com/) | USA | USA |
35| [Elechouse](http://www.elechouse.com/) | HK | HK |
36| [Lab401](https://lab401.com/) | EU | HK |
37| [RFxSecure](http://www.rfxsecure.com/) | CN | SG |
38| [Sneaktechnology](https://www.sneaktechnology.com/) | CN | CN |
9ebbfd89 39
3e7df262 40
b27c1909 41Most of the ultra-low-volume contract assemblers could put
770f7345 42something like this together with a reasonable yield. A run of around
43a dozen units is probably cost-effective. The BOM includes (possibly-
44outdated) component pricing, and everything is available from Digikey
45and the usual distributors.
46
47If you've never assembled a modern circuit board by hand, then this is
48not a good place to start. Some of the components (e.g. the crystals)
49must not be assembled with a soldering iron, and require hot air.
50
51The schematics are included; the component values given are not
52necessarily correct for all situations, but it should be possible to do
53nearly anything you would want with appropriate population options.
54
55The printed circuit board artwork is also available, as Gerbers and an
56Excellon drill file.
57
58
1ccdd4f6 59## License
770f7345 60
61This program is free software; you can redistribute it and/or modify
62it under the terms of the GNU General Public License as published by
63the Free Software Foundation; either version 2 of the License, or
64(at your option) any later version.
65
66This program is distributed in the hope that it will be useful,
67but WITHOUT ANY WARRANTY; without even the implied warranty of
68MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
69GNU General Public License for more details.
70
71You should have received a copy of the GNU General Public License
72along with this program; if not, write to the Free Software
73Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
74
75
76Jonathan Westhues
77user jwesthues, at host cq.cx
78
79May 2007, Cambridge MA
Impressum, Datenschutz