README.txt

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