diff --git a/README.md b/README.md index 149738cff..d9ac828de 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ | ------------------- |:-------------------:| -------------------:| |[What has changed?](#what-has-changed) | **[Setup and build for Linux](/doc/md/Installation_Instructions/Linux-Installation-Instructions.md)** | [Compilation Instructions](/doc/md/Use_of_Proxmark/0_Compilation-Instructions.md)| |[Development](#development) | **[Important notes on ModemManager for Linux users](/doc/md/Installation_Instructions/ModemManager-Must-Be-Discarded.md)** | [Validating proxmark client functionality](/doc/md/Use_of_Proxmark/1_Validation.md) | -|| **[Homebrew (Mac OS X) & Upgrading HomeBrew Tap Formula](/doc/md/Installation_Instructions/Mac-OS-X-Homebrew-Installation-Instructions.md)** | [First Use and Verification](/doc/md/Use_of_Proxmark/2_Configuration-and-Verification.md)| +|[Maintainers](#maintainers--package-distro-)| **[Homebrew (Mac OS X) & Upgrading HomeBrew Tap Formula](/doc/md/Installation_Instructions/Mac-OS-X-Homebrew-Installation-Instructions.md)** | [First Use and Verification](/doc/md/Use_of_Proxmark/2_Configuration-and-Verification.md)| |[Proxmark3 GUI](#proxmark3-gui)|**[Setup and build for Windows](/doc/md/Installation_Instructions/Windows-Installation-Instructions.md)**|[Commands & Features](/doc/md/Use_of_Proxmark/3_Commands-and-Features.md)| -|[Issues](#issues)|[Blue shark manual](/doc/bt_manual_v10.md) || -|[Donations](#Donations)|[Maintainers](/doc/md/Development/Maintainers.md)|[Command Cheat sheet](/doc/cheatsheet.md)| +|[Precompiled binaries](#precompiled-binaries)|[Blue shark manual](/doc/bt_manual_v10.md) || +|[Donations](#donations)||[Command Cheat sheet](/doc/cheatsheet.md)| ||[Advanced compilation parameters](/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md)|[More cheat sheets](https://github.com/RfidResearchGroup/proxmark3/wiki/More-cheat-sheets)| ||**[Troubleshooting](/doc/md/Installation_Instructions/Troubleshooting.md)**|[Complete client command set](/doc/commands.md)| ||**[JTAG](/doc/jtag_notes.md)**|[T5577 Introduction Guide](/doc/T5577_Guide.md)| @@ -59,39 +59,58 @@ With generic Proxmark3 platforms we mean: ## What has changed? -On the hardware side: - - * added flash memory 256kb. +Proxmark3 RDV4 hardware modifications: + * added flash memory 256kb * added smart card module * added FPC connector + * improved antennas, swappable, multi Q factor for LF + * tiny PCB form factor + * ABS case + +This repo vs official Proxmark3 repo: +see the [Changelog file](CHANGELOG.md) which we try to keep updated. In short this repo gives you an complete different user experience when it comes to Proxmark3. + * richer CLI with use of colors / emojis + * help text system implemented everywhere + * hints system + * user preference settings + * extensive testing with continues built systems and static analyse tools like + * [coverity scan](https://scan.coverity.com/projects/proxmark3-rrg-iceman-repo/) + * cppchecker + * CLANG + * auto detection of serial ports and seamless intergration with bluetooth addon + * reconnect to device + * -On the software side: -see the [Changelog file](CHANGELOG.md) which we try to keep updated. ## Development > ⚠ **Note**: This is a bleeding edge repository. The maintainers actively is working out of this repository and will be periodically re-structuring the code to make it easier to comprehend, navigate, build, test, and contribute to, so **DO expect significant changes to code layout on a regular basis**. +> 👉 **Remember!** If you intend to contribute to the code, please read the [coding style notes](HACKING.md) first. +We usually merge your contributions fast since we do like the idea of getting a functionality in the Proxmark3 and weed out the bugs afterwards. + +The [public roadmap](https://github.com/RfidResearchGroup/proxmark3/wiki/Public-Roadmap) is an excellent start to read if you are interesting in contributing. + + +## Supported operative systems This repo compiles nicely on - - Proxspace v3.x - - [latest release v3.8](https://github.com/Gator96100/ProxSpace/releases) - - Windows/mingw environment with Qt5.6.1 & GCC 4.9 - - Ubuntu, ParrotOS, Gentoo, Pentoo, Kali, Nethunter, Archlinux, Fedora, Debian - - Rasbian + - WSL1 on Windows 10 + - Proxspace v3.8 [release v3.8](https://github.com/Gator96100/ProxSpace/releases) + - Windows/mingw environment + - Ubuntu, ParrotOS, Gentoo, Pentoo, Kali, Nethunter, Archlinux, Fedora, Debian, Rasbian - Android / Termux - Mac OS X / Homebrew / Apple Silicon M1 - - WSL1 on Windows 10 - Docker container - [ RRG / Iceman repo based ubuntu 18.04 container ](https://hub.docker.com/r/secopsconsult/proxmark3) - [ Iceman fork based container v1.7 ](https://hub.docker.com/r/iceman1001/proxmark3/) ## Precompiled binaries -We don't maintain any precompiled binaries in this repo. There is community effort over at the Proxmark3 forum where [@gator96100](https://github.com/gator96100) has set up a AWS bucket with precompiled Proxspace (Mingw) binaries which is recompiled every night and with that also up-to-date. We link to these files here as to make it easier for users. +We don't maintain any precompiled binaries in this repo. There is community effort over at the Proxmark3 forum where package maintainer [@gator96100](https://github.com/gator96100) has set up a AWS bucket with precompiled Proxspace (Mingw) binaries which is recompiled every night and with that also up-to-date. We link to these files here as to make it easier for users. _If you use his pre-compiled Proxspace binaries do consider buy him a coffee for his efforts. Remember nothing says thank you as much as a donation._ -If you are having troubles with these files, contact package maintainer [@gator96100](https://github.com/gator96100) and read the [homepage of his proxmark builds](https://www.proxmarkbuilds.org/) or read the [sticky thread at forum](http://www.proxmark.org/forum/viewtopic.php?pid=24763#p24763) +If you are having troubles with these files, we suggest to read the [homepage of his proxmark builds](https://www.proxmarkbuilds.org/) or read the [sticky thread at forum](http://www.proxmark.org/forum/viewtopic.php?pid=24763#p24763) ### Proxmark3 RDV4 devices - [Precompiled builds for RDV40 dedicated x64](https://www.proxmarkbuilds.org/#rdv40-64/) @@ -101,21 +120,8 @@ If you are having troubles with these files, contact package maintainer [@gator9 - [Precompiled builds for RRG / Iceman repository x64](https://www.proxmarkbuilds.org/#rrg_other-64/) -## Roadmap -The [public roadmap](https://github.com/RfidResearchGroup/proxmark3/wiki/Public-Roadmap) is an excellent start to read if you are interesting in contributing. - -> 👉 **Remember!** If you intend to contribute to the code, please read the [coding style notes](HACKING.md) first. -We usually merge your contributions fast since we do like the idea of getting a functionality in the Proxmark3 and weed out the bugs afterwards. - - -## Issues & Troubleshooting -Please search the [issues](https://github.com/rfidresearchgroup/proxmark3/issues) page here and see if your issue is listed in the first instance. -Read the [Troubleshooting guide](/doc/md/Installation_Instructions/Troubleshooting.md) to weed out most known problems. - -Next place to visit is the [Proxmark3 Forum](http://www.proxmark.org/forum/index.php). - - -### Offical channels +## Offical channels +Where do you find the community? - [RFID Hacking community discord server](https://discord.gg/QfPvGFRQxH) - [Proxmark3 IRC channel](http://webchat.freenode.net/?channels=#proxmark3) - [Proxmark3 sub reddit](https://www.reddit.com/r/proxmark3/) @@ -135,7 +141,7 @@ The official PM3-GUI from Gaucho will not work. Not to mention is quite old and - [Proxmark3 Universal GUI](https://github.com/burma69/PM3UniversalGUI) will work more or less. -- [Proxmark3 GUI crosscompiled](https://github.com/wh201906/Proxmark3GUI/) which is recently updated and claims to support latest source of this repo. Give it a spin and let us know how it works for you. +- [Proxmark3 GUI crosscompiled](https://github.com/wh201906/Proxmark3GUI/) which is recently updated and claims to support latest source of this repo. # Donations