Add two missing bitflip state tables. Update .gitignore
[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
425b6c0e
J
33
34 * The Homebrew formula repository
35 https://github.com/Proxmark/homebrew-proxmark3
b27c1909
W
36
37DEVELOPMENT:
38
39The tools required to build or run the project will vary depending on
40your operating system. Please refer to the Wiki for details.
41
42 * https://github.com/Proxmark/proxmark3/wiki
770f7345 43
b27c1909 44OBTAINING HARDWARE:
770f7345 45
b0c76dd2 46The Proxmark 3 is available for purchase (assembled and tested) from the
b27c1909 47following locations:
770f7345 48
b27c1909
W
49 * http://proxmark3.com/
50 * http://www.xfpga.com/
69f30e32
I
51 * http://radiowar.taobao.com/
52 * http://www.elechouse.com/
53 * https://lab401.com/
770f7345 54
b27c1909 55Most of the ultra-low-volume contract assemblers could put
770f7345 56something like this together with a reasonable yield. A run of around
57a dozen units is probably cost-effective. The BOM includes (possibly-
58outdated) component pricing, and everything is available from Digikey
59and the usual distributors.
60
61If you've never assembled a modern circuit board by hand, then this is
62not a good place to start. Some of the components (e.g. the crystals)
63must not be assembled with a soldering iron, and require hot air.
64
65The schematics are included; the component values given are not
66necessarily correct for all situations, but it should be possible to do
67nearly anything you would want with appropriate population options.
68
69The printed circuit board artwork is also available, as Gerbers and an
70Excellon drill file.
71
72
770f7345 73LICENSING:
74
75This program is free software; you can redistribute it and/or modify
76it under the terms of the GNU General Public License as published by
77the Free Software Foundation; either version 2 of the License, or
78(at your option) any later version.
79
80This program is distributed in the hope that it will be useful,
81but WITHOUT ANY WARRANTY; without even the implied warranty of
82MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
83GNU General Public License for more details.
84
85You should have received a copy of the GNU General Public License
86along with this program; if not, write to the Free Software
87Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
88
89
90Jonathan Westhues
91user jwesthues, at host cq.cx
92
93May 2007, Cambridge MA
Impressum, Datenschutz