Merge pull request #5 from Acetolyne/update-readme

Updated Readme file to reflect Carnage repository

README.md

@@ -1,9 +1,9 @@
-# PortaPack Mayhem
+# PortaPack Carnage
 
 [![Build Status](https://travis-ci.com/eried/portapack-mayhem.svg?branch=master)](https://travis-ci.com/eried/portapack-mayhem) [![buddy pipeline](https://app.buddy.works/eried/portapack/pipelines/pipeline/252276/badge.svg?token=48cd59d53de0589a8fbe26bc751d77a59a011cf72581da049343879402991c34 "buddy pipeline")](https://app.buddy.works/eried/portapack/pipelines/pipeline/252276) [![CodeScene Code Health](https://codescene.io/projects/8381/status-badges/code-health)](https://codescene.io/projects/8381) [![Docker Hub Pulls](https://img.shields.io/docker/pulls/eried/portapack.svg)](https://hub.docker.com/r/eried/portapack)
 [![Discord Chat](https://img.shields.io/discord/719669764804444213.svg)](https://discord.gg/fU9PsKW)  
 
-This is a fork of the [Havoc](https://github.com/furrtek/portapack-havoc/) firmware, which itself was a fork of the [PortaPack](https://github.com/sharebrained/portapack-hackrf) firmware, an add-on for the [HackRF](http://greatscottgadgets.com/hackrf/). A fork is a derivate, in this case one that has extra features and fixes when compared to the older versions.
+This is a fork of the [Mayhem](https://github.com/eried/portapack-mayhem/) firmware, which itself was a fork of the [PortaPack](https://github.com/sharebrained/portapack-hackrf) firmware, an add-on for the [HackRF](http://greatscottgadgets.com/hackrf/). A fork is a derivate, in this case one that has extra features and fixes when compared to the older versions.
 
 [<img src="https://raw.githubusercontent.com/wiki/eried/portapack-mayhem/img/hw_overview_h2_front.png" height="400">](https://github.com/eried/portapack-mayhem/wiki/Hardware-overview) [<img src="https://raw.githubusercontent.com/wiki/eried/portapack-mayhem/img/hw_overview_h2_inside.png" height="400">](https://github.com/eried/portapack-mayhem/wiki/Hardware-overview#portapack-internals)
 
@@ -15,51 +15,22 @@ If you are new to *HackRF+PortaPack+Mayhem*, there is an awesome introductory vi
 
 [![Setup and overview](https://img.youtube.com/vi/kjFB58Y1TAo/0.jpg)](https://www.youtube.com/watch?v=kjFB58Y1TAo)
 
-# Frequently Asked Questions
-
-This repository expands upon the previous work by many people and aims to constantly add new features, bugfixes and generate documentation to make further development easier.  [Collaboration](https://github.com/eried/portapack-mayhem/wiki/How-to-collaborate) is always welcomed and appreciated.
-
 ## Does it work on H1/H2 PortaPack?
 
 Yes, both devices are the [same](https://github.com/eried/portapack-mayhem/wiki/First-steps). The one I am using to test all changes is this [PortaPack H2+HackRF+battery](https://s.click.aliexpress.com/e/_dSMPvNo), which is a kit that includes everything you need. Sadly, the people making the H2 never made the updated schematics available, which is not ideal (and goes against the terms of the license).
 
 To support the people behind the hardware, please buy a genuine [HackRF](https://greatscottgadgets.com/hackrf/) and [PortaPack](https://store.sharebrained.com/products/portapack-for-hackrf-one-kit).
 
-## Where is the latest firmware?
-
-The current stable release is on the [![GitHub release (latest by date)](https://img.shields.io/github/v/release/eried/portapack-mayhem?label=Releases&style=social)](https://github.com/eried/portapack-mayhem/releases/latest) page. Follow the instructions you can find in the release description. There is also [nightly builds](https://github.com/eried/portapack-mayhem/releases/tag/nightly) generated periodically, which include the latest commits, but they may contain incomplete or buggy functionality.
-
-## Is this the newest firmware for my PortaPack? 
-Most probably: **YES**. *If you find new features somewhere else, please [suggest](https://github.com/eried/portapack-mayhem/issues/new/choose) them*.
-
-## Which one is actually the newest?
-There is a lot of confusion of which is the latest version because no old version used any actual "version number". Additionally, since the files were distributed on facebook groups, github issue links and similar temporal sources, then there was no central location for them. 
-
-This fork (**Mayhem**) uses *major.minor.release* [semantic versioning](https://en.wikipedia.org/wiki/Software_versioning), so you can always compare your current version with the latest from [Releases](https://github.com/eried/portapack-mayhem/releases/latest).
 
 ## What about Havoc/GridRF/jamesshao8/jboone's?
 * jboone's PortaPack: the [vanilla](https://en.wikipedia.org/wiki/Vanilla_software) experience
 * Havoc: It was the most popular fork of jboone's PortaPack, currrently, it is not being maintained nor updated
 * jamesshao8: He keeps his own version of the fork, while not attached as a fork to anything
 * GridRF: They sell PortaPack clones with their own firmware based on a old version, which has no sourcecode available
 
-## How can I collaborate
-You can write [documentation](https://github.com/eried/portapack-mayhem/wiki), fix bugs and [answer issues](https://github.com/eried/portapack-mayhem/issues) or add new functionality. Please check the following [guide](https://github.com/eried/portapack-mayhem/wiki/How-to-collaborate) with details.
-
-Consider that the hardware and firmware has been created and maintain by a [lot](https://github.com/mossmann/hackrf/graphs/contributors) of [people](https://github.com/eried/portapack-mayhem/graphs/contributors), so always try colaborating your time and effort first. For coding related questions, if something does not fit as an issue, please join our [Channel in Discord](https://discord.gg/fU9PsKW).
-
-As a last option, if you want to send money directly to me for getting more boards, antennas and such:
-
-[![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=CBPQA4HRRPJQ6&source=url)
-
-## What if I need help?
-First, check the [documentation](https://github.com/eried/portapack-mayhem/wiki). If you find a bug or you think the problem is related to the current repository, please open an [issue](https://github.com/eried/portapack-mayhem/issues/new/choose).
-
+## Resources
 You can reach the [official community](https://www.facebook.com/groups/177623356165819) in Facebook. 
 
-## What if I find incongruencies, or grammatical errors in the text?
-If is on the [Wiki](https://github.com/eried/portapack-mayhem/wiki), you can modify it directly. If is on files of the repository, you can send corrections as [pull requests](https://github.com/eried/portapack-mayhem/wiki/How-to-collaborate#coding-new-stuff-or-fixing-bugs). As a last resource, open an [issue](https://github.com/eried/portapack-mayhem/issues/new/choose).
-
 
 ## Tools
 
@@ -74,7 +45,7 @@ You will need a few tools installed on your computer before you begin.
 
 The source code is hosted on GitHub. Change to a directory where you want the source code, and clone the source repository.
 
-git clone --recurse-submodules https://github.com/Acetolyne/portapack-havoc.git
+git clone --recurse-submodules https://github.com/Acetolyne/portapack-carnage.git
 
 Change directories into the cloned repository.
 
@@ -92,7 +63,7 @@ Make the SPI flash binary image (which builds the bootstrap, application, and ba
 
 make firmware
 
-The binary will be at "firmware/portapack-h1-havoc.bin". under the build directory that you are currently in.
+The binary will be at "firmware/portapack-h1-havoc.bin". under the build directory that you are currently in. (TODO binary location possibly needs updated)
 
 ## Flashing Firmware
 
@@ -127,7 +98,7 @@ When finished, press the reset button on the HackRF. The PortaPack code is now r
 
 2. cd to the firmware
 
-2. Flash the havoc firmware with ```hackrf_spiflash -w portapack-h1-havoc.bin```
+2. Flash the havoc firmware with ```hackrf_spiflash -w portapack-h1-havoc.bin``` (TODO again file name may be different now)
 
 - If the hackrf_spiflash program is not available you have not built it yet. follow the directions below then try reflashing with the above command.