Merge pull request #494 from qaisjp/patch-1

Make README file markdown
This commit is contained in:
Iceman 2017-11-26 06:15:48 +01:00 committed by GitHub
commit 14971507b1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,56 +1,37 @@
NOTICE: # proxmark3: the official Proxmark repository!
(2014-03-26)
This is now the official Proxmark repository!
INTRODUCTION:
The proxmark3 is a powerful general purpose RFID tool, the size of a deck The proxmark3 is a powerful general purpose RFID tool, the size of a deck
of cards, designed to snoop, listen and emulate everything from of cards, designed to snoop, listen and emulate everything from
Low Frequency (125kHz) to High Frequency (13.56MHz) tags. **Low Frequency (125kHz)** to **High Frequency (13.56MHz)** tags.
This repository contains enough software, logic (for the FPGA), and design This repository contains enough software, logic (for the FPGA), and design
documentation for the hardware that you could, at least in theory, documentation for the hardware that you could, at least in theory,
do something useful with a proxmark3. do something useful with a proxmark3.
RESOURCES: ## Resources
* This repository! * [This repository!](https://github.com/Proxmark/proxmark3)
https://github.com/Proxmark/proxmark3 * [The Wiki](https://github.com/Proxmark/proxmark3/wiki)
* [The GitHub Pages website](http://proxmark.github.io/proxmark3/)
* The Wiki * [The Forum](http://www.proxmark.org/forum)
https://github.com/Proxmark/proxmark3/wiki * The IRC channel: irc.freenode.org #proxmark3 ([chat in your browser](http://webchat.freenode.net/?channels=#proxmark3))
* [The Homebrew formula repository](https://github.com/Proxmark/homebrew-proxmark3)
* The GitHub page
http://proxmark.github.io/proxmark3/
* The Forum
http://www.proxmark.org/forum
* The IRC chanel
irc.freenode.org #proxmark3
-or-
http://webchat.freenode.net/?channels=#proxmark3
* The Homebrew formula repository
https://github.com/Proxmark/homebrew-proxmark3
DEVELOPMENT: ## Development
The tools required to build or run the project will vary depending on The tools required to build or run the project will vary depending on
your operating system. Please refer to the Wiki for details. your operating system. Please refer to [the wiki](https://github.com/Proxmark/proxmark3/wiki) for details.
* https://github.com/Proxmark/proxmark3/wiki ## Obtaining hardware
OBTAINING HARDWARE:
The Proxmark3 is available for purchase (assembled and tested) from the The Proxmark3 is available for purchase (assembled and tested) from the
following locations: following locations:
* https://proxmark3.com/ - RyscCorp (us) * [RyscCorp](https://proxmark3.com/) (US)
* http://www.elechouse.com/ - Elechouse (HK) * [Elechouse](http://www.elechouse.com/) (HK)
* https://lab401.com/ - Lab401 (FR) * [Lab401](https://lab401.com/) (FR)
* http://www.rfxsecure.com/ - RFxSecure (SG) * [RFxSecure](http://www.rfxsecure.com/) (SG)
* http://proxmark3.tictail.com/ - IceSQL (SE) * [IceSQL](http://proxmark3.tictail.com/) (SE)
Most of the ultra-low-volume contract assemblers could put Most of the ultra-low-volume contract assemblers could put
something like this together with a reasonable yield. A run of around something like this together with a reasonable yield. A run of around
@ -70,7 +51,7 @@ The printed circuit board artwork is also available, as Gerbers and an
Excellon drill file. Excellon drill file.
LICENSING: ## License
This program is free software; you can redistribute it and/or modify This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by it under the terms of the GNU General Public License as published by