rework readme

readme.txt moved as it's pandora specific really

diff --git a/Makefile b/Makefile
index 6be3537..92c4301 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -564,7 +564,7 @@ ifeq "$(PLATFORM)" "generic"
 OUT = pcsx_rearmed_$(VER)
 
 rel: pcsx $(PLUGINS) \
-               frontend/pandora/skin readme.txt COPYING
+               frontend/pandora/skin README.md COPYING
        rm -rf $(OUT)
        mkdir -p $(OUT)/plugins
        mkdir -p $(OUT)/bios
@@ -578,7 +578,7 @@ PND_MAKE ?= $(HOME)/dev/pnd/src/pandora-libraries/testdata/scripts/pnd_make.sh
 
 rel: pcsx plugins/dfsound/pcsxr_spu_area3.out $(PLUGINS) \
                frontend/pandora/pcsx.sh frontend/pandora/pcsx.pxml.templ frontend/pandora/pcsx.png \
-               frontend/pandora/picorestore frontend/pandora/skin readme.txt COPYING
+               frontend/pandora/picorestore frontend/pandora/skin frontend/pandora/readme.txt COPYING
        rm -rf out
        mkdir -p out/plugins
        cp -r $^ out/
@@ -593,7 +593,7 @@ ifeq "$(PLATFORM)" "miyoo"
 rel: pcsx $(PLUGINS) \
                frontend/320240/pcsx26.png \
                frontend/320240/skin \
-               readme.txt COPYING
+               README.md COPYING
        rm -rf out
        mkdir -p out/pcsx_rearmed/plugins
        cp -r $^ out/pcsx_rearmed/
@@ -619,7 +619,7 @@ rel: pcsx $(PLUGINS) \
                frontend/warm/bin/warm_2.6.24.ko frontend/320240/pollux_set \
                frontend/320240/pcsx_rearmed.ini frontend/320240/haptic_w.cfg \
                frontend/320240/haptic_s.cfg \
-               readme.txt COPYING
+               COPYING
        rm -rf out
        mkdir -p out/pcsx_rearmed/plugins
        cp -r $^ out/pcsx_rearmed/

diff --git a/README.md b/README.md
index be7093c..dd731d7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -3,37 +3,20 @@ PCSX-ReARMed - yet another PCSX fork
 
 ![CI (Linux)](https://github.com/notaz/pcsx_rearmed/workflows/CI%20(Linux)/badge.svg)
 
-*see [readme.txt](readme.txt) for more complete documentation*
-
 PCSX ReARMed is yet another PCSX fork based on the PCSX-Reloaded project,
 which itself contains code from PCSX, PCSX-df and PCSX-Revolution. This
-version is ARM architecture oriented and features MIPS->ARM recompiler by
-Ari64, NEON GTE code and more performance improvements. It was created for
-Pandora handheld, but should be usable on other devices after some code
-adjustments (N900, GPH Wiz/Caanoo, PlayBook versions are also available).
-
-PCSX ReARMed features ARM NEON GPU by Exophase, that in many cases produces
-pixel perfect graphics at very high performance. There is also Una-i's GPU
-plugin from PCSX4ALL project, and traditional P.E.Op.S. one.
-
-
-PCSX-Reloaded
-=============
-
-PCSX-Reloaded is a forked version of the dead PCSX emulator, with a nicer
-interface and several improvements to stability and functionality.
-
-PCSX-Reloaded uses the PSEMU plugin interface to provide most functionality;
-without them, you will not be able to use it to play games. PCSX-Reloaded
-provides a number of plugins to provide basic functionality out of the box.
-
-PCSX-Reloaded has a very capable Internal HLE BIOS that can run many games
-without problems. It is recommended that you use it. However, if you own a
-real PlayStation, you may be able to use your own BIOS image. PCSX-Reloaded
-will find it in ~/.pcsx/bios/ or /usr/share/psemu/bios/ if you place it there.
-This can improve compatibility, especially with certain games and with the
-use of memory cards.
+version was originally ARM architecture oriented (hence the name) with
+its MIPS->ARM dynamic recompilation and assembly optimizations, but more
+recently it targets other architectures too. A fork of this emulator was
+used in [PS Classic](https://en.wikipedia.org/wiki/PlayStation_Classic)
+(without any coordination or even notification).
+
+## Features
+* ARM/ARM64 dynamic recompiler by Ari64
+* [lightrec](https://github.com/pcercuei/lightrec/) dynamic recompiler for other architectures
+* NEON GPU by Exophase for ARM NEON and x86 SSE2+
+* PCSX4ALL GPU by Una-i/senquack for other architectures
+* heavily modified P.E.Op.S. SPU
+* BIOS HLE emulation (most games run without proprietary BIOS)
+* libretro support
 
-See the doc/ folder in the source, or /usr/share/doc/pcsx/ on Debian systems,
-for more detailed information on PCSX-Reloaded. A UNIX manpage is also
-available.

diff --git a/readme.txt b/frontend/pandora/readme.txt
similarity index 100%
rename from readme.txt
rename to frontend/pandora/readme.txt