Merge pull request #302 from pwpiwi/fix_QtThreads
[legacy-proxmark3.git] / README.txt
blobbb4dceb81cf409ec210242556e7ff39f6fa84907
1 NOTICE:
2 (2014-03-26)
3 This is now the official Proxmark repository!
5 INTRODUCTION:
7 The proxmark3 is a powerful general purpose RFID tool, the size of a deck
8 of cards, designed to snoop, listen and emulate everything from
9 Low Frequency (125kHz) to High Frequency (13.56MHz) tags.
11 This repository contains enough software, logic (for the FPGA), and design
12 documentation for the hardware that you could, at least in theory,
13 do something useful with a proxmark3.
15 RESOURCES:
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        
34    * The Homebrew formula repository
35       https://github.com/Proxmark/homebrew-proxmark3
36    
37 DEVELOPMENT:
39 The tools required to build  or run the project will vary depending on
40 your operating system. Please refer to the Wiki for details.
42    * https://github.com/Proxmark/proxmark3/wiki
44 OBTAINING HARDWARE:
46 The Proxmark 3 is available for purchase (assembled and tested) from the
47 following locations:
49    * http://proxmark3.com/
50    * http://www.xfpga.com/
51    * http://radiowar.taobao.com/
52    * http://www.elechouse.com/
53    * https://lab401.com/
55 Most of the ultra-low-volume contract assemblers could put
56 something like this together with a reasonable yield. A run of around
57 a dozen units is probably cost-effective. The BOM includes (possibly-
58 outdated) component pricing, and everything is available from Digikey
59 and the usual distributors.
61 If you've never assembled a modern circuit board by hand, then this is
62 not a good place to start. Some of the components (e.g. the crystals)
63 must not be assembled with a soldering iron, and require hot air.
65 The schematics are included; the component values given are not
66 necessarily correct for all situations, but it should be possible to do
67 nearly anything you would want with appropriate population options.
69 The printed circuit board artwork is also available, as Gerbers and an
70 Excellon drill file.
73 LICENSING:
75 This program is free software; you can redistribute it and/or modify
76 it under the terms of the GNU General Public License as published by
77 the Free Software Foundation; either version 2 of the License, or
78 (at your option) any later version.
80 This program is distributed in the hope that it will be useful,
81 but WITHOUT ANY WARRANTY; without even the implied warranty of
82 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
83 GNU General Public License for more details.
85 You should have received a copy of the GNU General Public License
86 along with this program; if not, write to the Free Software
87 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
90 Jonathan Westhues
91 user jwesthues, at host cq.cx
93 May 2007, Cambridge MA