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