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