Review first: Documentation updates (#448)

* Add gif for installation in RetroPie

* Move files into docs folder

* Include icon in Readme

* Tweaks to the source of the gif.

docs/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at dimitris@blitterstudio.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

docs/README.md

@@ -0,0 +1,103 @@
+<img src="resources/icon.png" align="right" />
+
+# Amiga emulator for the Raspberry Pi and other ARM SoC
+Amiberry is an optimized Amiga emulator, for ARM-based boards (like the Raspberry Pi, ASUS Tinkerboard, Odroid XU4, etc). The core emulation comes from WinUAE, but stripped down to remove excess stuff in order to achieve good performance in underpowered boards. It includes JIT CPU and FPU support, to get high-performance results on CPU-intensive emulated environments. On top of that, we have some unique features developed only for Amiberry, such as the WHDLoad booter.
+
+Amiberry requires the SDL framework (https://libsdl.org) for graphics display, input handling and audio out. Currently both SDL1.x and SDL2 are supported, but in the future we'll probably drop support for SDL1 as things move forward. On the RPI platform specifically, we offer a special version which uses Dispmanx directly for the emulation screen, for maximum performance.
+
+# Compiling SDL2
+If you want to run the SDL2 version, you currently need to compile SDL2 from source on the Raspberry Pi, to get support for launching full screen applications from the console. The version bundled with Raspbian Stretch is unfortunately not compiled with support for the "KMSDRM" driver, so it only works under X11. Furthermore, it is an older version and includes some known bugs, which were fixed in later updates of SDL2.
+
+Follow these steps to download, compile and install SDL2 from source:
+
+https://github.com/midwan/amiberry/wiki/Compile-SDL2-from-source
+      
+With SDL2 installed, you can proceed to install Amiberry as follows:
+
+# Pre-requisites
+Amiberry requires the following packages, besides SDL (v1 or v2) itself:
+
+      sudo apt-get install libxml2-dev libflac-dev libmpg123-dev libpng-dev libmpeg2-4-dev
+
+# Getting Amiberry
+You can clone this repo, like so:
+      
+      cd ~
+      git clone https://github.com/midwan/amiberry
+      cd amiberry
+      
+# Choosing a target
+Amiberry's makefile includes several targets, to cover various platforms. For the Raspberry Pi platform specifically, we offer multiple combinations to get the best performance out of the platform, depending on the environment used:
+- SDL1 with DispmanX back-end for graphics
+- SDL2 with DispmanX back-end for graphics
+- SDL2 with whatever back-end it was configured with (e.g. KMS, OpenGL, X11, etc.)
+
+For the Raspberry Pi specifically, the best performance can be gained by using the DispmanX back-end, because none of the other options offer multi-threaded graphics updates, unfortunately. For other platforms (e.g. using the Mali GPU), multi-threaded updates can be supported using pure SDL2 (and DispmanX is an RPI-only feature anyway).
+
+# Compiling a target
+You can specify the Platform you want to build as a parameter to the `make` command. If you do not specify one, the default used will be `rpi3-sdl2-dispmanx`.
+
+## Using SDL1 + DispmanX
+For the Raspberry Pi 3(B+) (SDL1 + Dispmanx), type:
+
+      make -j2 PLATFORM=rpi3
+
+For the Raspberry Pi 2 (SDL1 + Dispmanx), type:
+
+      make -j2 PLATFORM=rpi2
+
+For the Raspberry Pi 1/Zero (SDL1 + Dispmanx), type:
+
+      make PLATFORM=rpi1
+
+## Using SDL2 + DispmanX
+
+For the Raspberry Pi 3(B+) (SDL2)
+
+      make -j2 PLATFORM=rpi3-sdl2-dispmanx
+
+For the Raspberry Pi 2 (SDL2):
+
+      make -j2 PLATFORM=rpi2-sdl2-dispmanx
+      
+For the Raspberry Pi 1/Zero (SDL2):
+
+      make PLATFORM=rpi1-sdl2-dispmanx
+
+## Using SDL2 + whatever back-end it was configured with
+
+For the Raspberry Pi 3(B+) (SDL2)
+
+      make -j2 PLATFORM=rpi3-sdl2
+
+For the Raspberry Pi 2 (SDL2):
+
+      make -j2 PLATFORM=rpi2-sdl2
+      
+For the Raspberry Pi 1/Zero (SDL2):
+
+      make PLATFORM=rpi1-sdl2
+
+For the Odroid XU4 (SDL2):
+
+      make -j6 PLATFORM=xu4
+      
+For the ASUS Tinker board (SDL2):
+
+      make -j6 PLATFORM=tinker
+      
+For the Odroid C1 (SDL2):
+
+      make -j4 PLATFORM=c1
+
+For the Vero 4k (SDL2):
+
+      make -j4 PLATFORM=vero4k
+     
+For the OrangePi PC (SDL2):
+
+      make -j2 PLATFORM=orangepi-pc
+      
+You can check the Makefile for a full list of supported platforms!
+
+For more documentation subjects, please check the [Wiki page](https://github.com/midwan/amiberry/wiki)