Merge pull request #969 from pwpiwi/gcc10_fixes
[proxmark3-svn] / README.md
1 # proxmark3: the official Proxmark repository!
2
3 The proxmark3 is a powerful general purpose RFID tool, the size of a deck
4 of cards, designed to snoop, listen and emulate everything from
5 **Low Frequency (125kHz)** to **High Frequency (13.56MHz)** tags.
6
7 This repository contains enough software, logic (for the FPGA), and design
8 documentation for the hardware that you could, at least in theory,
9 do something useful with a proxmark3.
10
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)
19 * [Proxmark3 community discord server](https://discord.gg/86VcRtS)
20
21 ## Development
22
23 The tools required to build or run the project will vary depending on
24 your operating system. Please refer to [the wiki](https://github.com/Proxmark/proxmark3/wiki) for details.
25
26 ## Obtaining hardware
27
28 The Proxmark3 is available for purchase (assembled and tested) from the
29 following locations:
30
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 |
39
40
41 Most of the ultra-low-volume contract assemblers could put
42 something like this together with a reasonable yield. A run of around
43 a dozen units is probably cost-effective. The BOM includes (possibly-
44 outdated) component pricing, and everything is available from Digikey
45 and the usual distributors.
46
47 If you've never assembled a modern circuit board by hand, then this is
48 not a good place to start. Some of the components (e.g. the crystals)
49 must not be assembled with a soldering iron, and require hot air.
50
51 The schematics are included; the component values given are not
52 necessarily correct for all situations, but it should be possible to do
53 nearly anything you would want with appropriate population options.
54
55 The printed circuit board artwork is also available, as Gerbers and an
56 Excellon drill file.
57
58
59 ## License
60
61 This program is free software; you can redistribute it and/or modify
62 it under the terms of the GNU General Public License as published by
63 the Free Software Foundation; either version 2 of the License, or
64 (at your option) any later version.
65
66 This program is distributed in the hope that it will be useful,
67 but WITHOUT ANY WARRANTY; without even the implied warranty of
68 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
69 GNU General Public License for more details.
70
71 You should have received a copy of the GNU General Public License
72 along with this program; if not, write to the Free Software
73 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
74
75
76 Jonathan Westhues
77 user jwesthues, at host cq.cx
78
79 May 2007, Cambridge MA
Impressum, Datenschutz