Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Zlika committed Jul 30, 2018
1 parent df94be5 commit b9f78ed
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 29 deletions.
3 changes: 2 additions & 1 deletion CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Next Release
Release 1.2 (2018/07/30)
===========
* Add full support for SAP files (without conversion to FD format).
* Fix build for 3DS, PS3 and MSVC2003/2005/2010.
* Release keys pressed through the virtual keyboard (fixes Avenger game).

Release 1.1 (2018/06/21)
===========
Expand Down
18 changes: 4 additions & 14 deletions README-FR.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ Cet émulateur est disponible sur les plateformes suivantes :
* RetroArch : [Installer RetroArch](http://www.retroarch.com/?page=platforms), puis démarrer RetroArch et télécharger le core "theodore" via le "Core Updater".
* [Recalbox](https://www.recalbox.com/) : Theodore est inclus dans votre console de retrogaming préférée depuis la version 2018.06.27.

Il devrait être compatible avec toutes les plateformes supportées par RetroArch (Android, Linux, MacOS, Raspberry Pi, Windows, Nintendo...).

### Instructions de compilation

Sur Linux (et la plupart des autres plateformes) :
Expand Down Expand Up @@ -58,6 +60,8 @@ L'ordre des touches du clavier virtuel est : chiffres (0 à 9), puis lettres (A
| F1-F5 | F1-F5 |
| F6-F10 | SHIFT+F1-F5 |

RetroArch utilise beaucoup de raccourcis clavier, ce qui interfère avec l'émulation du clavier de ce core. Pour éviter ce problème, il suffit de configurer une "Hotkey" pour RetroArch, comme indiqué dans [Introduction to Hotkeys](https://docs.libretro.com/guides/retroarch-keyboard-controls/#introduction-to-hotkeys).

### :floppy_disk: Formats de fichiers supportés

L'émulateur peut lire les formats de fichiers suivants : *.fd et *.sap (disquettes), *.k7 (cassettes), *.m7 et *.rom (cartouches).
Expand All @@ -76,17 +80,3 @@ L'émulateur permet d'utiliser des codes de triche ("cheat codes") au format sui

Cf. le répertoire "cheat" qui contient des exemples de cheat codes ainsi qu'un script Python permettant de trouver des cheat codes à partir de plusieurs fichiers de sauvegarde instantanée (save states).

### Compatibilité

Le code source est portable et devrait compiler et s'exécuter sur la plupart des plateformes.
La tâche Travis vérifie la compilation sous Linux et MacOS, et la tâche AppVeyor vérifie la compilation sous Windows.

| Platforme | Compile | Exécute |
| --- | :---: | :---: |
| Linux / amd64 | :heavy_check_mark: | :heavy_check_mark: |
| Raspbian / Raspberry Pi | :heavy_check_mark: | :heavy_check_mark: |
| Android | :heavy_check_mark: | :heavy_check_mark: |
| MacOS | :heavy_check_mark: | :question: |
| Windows | :heavy_check_mark: | :heavy_check_mark: |
| Autres | :question: | :question: |

18 changes: 4 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ This emulator is available on the following platforms:
* RetroArch: [Install RetroArch](http://www.retroarch.com/?page=platforms), then start RetroArch and download the "theodore" core using the "Core Updater" feature.
* [Recalbox](https://www.recalbox.com/): Starting from version 2018.06.27, this emulator is built in your favorite retrogaming operating system.

It should be compatible with all the platforms supported by RetroArch (Android, Linux, MacOS, Raspberry Pi, Windows, Nintendo...).

### How to compile

On Linux (and most other platforms):
Expand Down Expand Up @@ -58,6 +60,8 @@ The order of the keys in the virtual keyboard is: digits (0->9) then letters (A-
| F1-F5 | F1-F5 |
| F6-F10 | SHIFT+F1-F5 |

RetroArch already uses lots of keyboard shortcuts for its own need that interfere with the core's keyboard emulation. To avoid this problem, configure RetroArch with a "Hotkey", as indicated in [Introduction to Hotkeys](https://docs.libretro.com/guides/retroarch-keyboard-controls/#introduction-to-hotkeys).

### :floppy_disk: File formats

The emulator can read the following file formats: *.fd and *.sap (floppy disks), *.k7 (tapes), *.m7 and *.rom (cartridges).
Expand All @@ -76,17 +80,3 @@ The emulator supports cheat codes with the following format: 0AAAAA:DD with AAAA

Cf. the "cheat" directory for some actual cheat codes, as well as a Python script that helps find cheat codes from a set of save state files.

### Compatibility

The source code is portable and should compile and run on most platforms.
The Travis job checks that the code builds on Linux and MacOS, and the AppVeyor job checks that the code builds on Windows.

| Platform | Compiles | Runs |
| --- | :---: | :---: |
| Linux / amd64 | :heavy_check_mark: | :heavy_check_mark: |
| Raspbian / Raspberry Pi | :heavy_check_mark: | :heavy_check_mark: |
| Android | :heavy_check_mark: | :heavy_check_mark: |
| MacOS | :heavy_check_mark: | :question: |
| Windows | :heavy_check_mark: | :heavy_check_mark: |
| Others | :question: | :question: |

0 comments on commit b9f78ed

Please sign in to comment.