From 6bb47f355fc963a074ecf375aac5316fb2c026f5 Mon Sep 17 00:00:00 2001 From: Iceman Date: Wed, 20 May 2020 10:24:20 +0200 Subject: [PATCH] Update README.md --- README.md | 40 ++++++++++++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 1c4cdaf83..1c7eb891c 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # RRG / Iceman repo - Proxmark3 + + | Releases | Linux & OSX CI | Windows CI | Coverity | | ------------------- |:-------------------:| -------------------:| -------------------:| | [![Latest release](https://img.shields.io/github/release/RfidResearchGroup/proxmark3.svg)](https://github.com/RfidResearchGroup/proxmark3/releases/latest) | [![Build status](https://api.travis-ci.org/RfidResearchGroup/proxmark3.svg?branch=master)](https://travis-ci.org/RfidResearchGroup/proxmark3) | [![Build status](https://ci.appveyor.com/api/projects/status/b4gwrhq3nc876cuu/branch/master?svg=true)](https://ci.appveyor.com/project/RfidResearchGroup/proxmark3/branch/master) | [![Coverity Status](https://scan.coverity.com/projects/19334/badge.svg)](https://scan.coverity.com/projects/proxmark3-rrg-iceman-repo)| @@ -23,6 +25,7 @@ ## Notes / helpful documents + | Notes ||| | ------------------- |:-------------------:| -------------------:| |[Notes on UART](/doc/uart_notes.md)|[Notes on Termux / Android](/doc/termux_notes.md)|[Notes on paths](/doc/path_notes.md)| @@ -31,6 +34,8 @@ |[Notes on file formats used with Proxmark3](/doc/extensions_notes.md)||| |[Developing standalone mode](/armsrc/Standalone/readme.md)|[Wiki about standalone mode](https://github.com/RfidResearchGroup/proxmark3/wiki/Standalone-mode)|| + + ## Build for non-RDV4 Proxmark3 platforms In order to build this repo for other Proxmark3 platforms we urge you to read [Advanced compilation parameters](/doc/md/Use_of_Proxmark/4_Advanced-compilation-parameters.md) @@ -52,14 +57,22 @@ On the software side: quite a lot, see the [Changelog file](CHANGELOG.md). This repo compiles nicely on - Proxspace v3.x - - Windows/mingw environment with Qt5.6.1 & GCC 4.8 - - Ubuntu 1604, 1804, 1904, 2004 + - [latest release v3.4](https://github.com/Gator96100/ProxSpace/releases) + - Windows/mingw environment with Qt5.6.1 & GCC 4.9 + - Ubuntu 1604 -> 2004 - ParrotOS, Gentoo, Pentoo, Kali, Nethunter, Archlinux, Fedora, Debian - - Rasbian Pi, Jetson Nano, - Android / Termux - Mac OS X / Homebrew - WSL, WSL2 (Windows subsystem linux) 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/) + +Hardware to run client on + - PC + - Andriod + - Rasbian Pi + - Jetson Nano The [public roadmap](https://github.com/RfidResearchGroup/proxmark3/wiki/Public-Roadmap) is an excellent start to read if you are interesting in contributing. @@ -67,6 +80,20 @@ The [public roadmap](https://github.com/RfidResearchGroup/proxmark3/wiki/Public- 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. Next place to visit is the [Proxmark Forum](http://www.proxmark.org/forum/index.php). Learn to search it well and finally Google / duckduckgo is your friend :) You will find many blogposts, youtube videos, tweets, reddit + +Read the [Troubleshooting](/doc/md/Installation_Instructions/Troubleshooting.md) guide to weed out most known problems. + +Offical channels + - [Proxmark3 IRC channel](http://webchat.freenode.net/?channels=#proxmark3) + - [Proxmark3 sub reddit](https://www.reddit.com/r/proxmark3/) + - [Twitter](https://twitter.com/proxmark3/) + + _no discord or slack channel_ + +Iceman has quite a few videos on his [youtube channel](https://www.youtube.com/c/ChrisHerrmann1001) + ## Cheat sheet Thanks to Alex Dibs, you can enjoy a [command cheat sheet](/doc/cheatsheet.md) @@ -85,13 +112,6 @@ The separation from official Proxmark3 repo gives us a lot of freedom to create The official PM3-GUI from Gaucho will not work. The new universal GUI will work. [Proxmark3 Universal GUI](https://github.com/burma69/PM3UniversalGUI) Almost, change needed in order to show helptext when client isn't connected to a device. -## Issues - -Please see the [Proxmark Forum](http://www.proxmark.org/forum/index.php) and see if your issue is listed in the first instance Google is your friend :) Questions will be answered via the forum by Iceman and the team. - -Read the [Troubleshooting](/doc/md/Installation_Instructions/Troubleshooting.md) guide to weed out most known problems. - - ## The end - July 2018 [@herrmann1001](https://mobile.twitter.com/herrmann1001)