From 4d5b37fab17d3229b6a7a211a8ec95f4d41e5f57 Mon Sep 17 00:00:00 2001 From: LeMoustachu Date: Tue, 21 Jun 2022 18:09:41 +0200 Subject: [PATCH] Improvements to README.md and README.fr.md (#256) * [README] clean fedora dependencies installation instruction * [README] n0110 instructions clearification * [README] add instruction for native simulator build * Fix translation Changed "native simulator" into "simulateur natif" Co-authored-by: Yaya-Cout * [README] add automatic platform detection command to native simulator instructions * [README.fr] fix translations * Update README.fr.md change "apps external" into "appllications externes" Co-authored-by: Yaya-Cout * Update README.fr.md Co-authored-by: Yaya-Cout Co-authored-by: Yaya-Cout --- README.fr.md | 84 +++++++++++++++++++++++++++++++++------------------- README.md | 65 +++++++++++++++++++++++++++------------- 2 files changed, 99 insertions(+), 50 deletions(-) diff --git a/README.fr.md b/README.fr.md index c9e918436..9c6cbacd3 100644 --- a/README.fr.md +++ b/README.fr.md @@ -70,22 +70,10 @@ C'est fait! Vous pouvez aller à l'étape 2.
-Installez tout d'abord des outils de développement. +Installez toutes les dépendances grâce à cette commande: ```bash -dnf install make automake gcc gcc-c++ kernel-devel -``` - -Puis les pquets requis: - -```bash -dnf install git ImageMagick libX11-devel libXext-devel freetype-devel libpng-devel libjpeg-devel pkg-config -``` - -Et enfin la version pour ARM de GCC: - -```bash -dnf install arm-none-eabi-gcc-cs arm-none-eabi-gcc-cs-c++ +dnf install make automake gcc gcc-c++ kernel-devel git ImageMagick libX11-devel libXext-devel freetype-devel libpng-devel libjpeg-devel pkg-config arm-none-eabi-gcc-cs arm-none-eabi-gcc-cs-c++ ```
@@ -106,7 +94,7 @@ Il est recommandé d'utiliser [Homebrew](https://brew.sh/). Une fois intsallé, brew install numworks/tap/epsilon-sdk ``` -Et toutes les dependances seront installées. +Et toutes les dépendances seront installées.
@@ -290,63 +278,99 @@ pour compiler les binpacks que vous pouvez distribuer et flasher depuis le [Ti-p
-Model bootloader (N0110) +Model n0110 + +Le bootloader vous permet d'installer firmware dans des "slots" séparés. Dans ce cas les applications externes ne pourront pas utiliser toute la mémoire mais la moitié. Si un seul slot est utilisé, le bootloader permettra d'utiliser toute la mémoire. Sans bootloader, les apps external peuvent utiliser toute la mémoire. + +
+Bootloader + +Votre calculatrice doit être flashé avec le bootloader d'[Upsilon](https://getupsilon.web.app) ou d'[Omega](https://getomega.dev). +Compilez avec: ```bash make clean -make OMEGA_USERNAME="{Votre nom, maximum 15 caractères}" -j4 +make OMEGA_USERNAME="{Votre nom, max 15 caractères}" -j4 ``` -Maintenant, lancez soit: +Ensuite lancez soit: ```bash make epsilon.A_flash ``` -pour directement flasher la calculatrice, ou avec le flasher de slots du bootloader avec RESET, puis 4 (menu de flash), et 1 (flash des slots). +pour flasher le slot actuel ou pour flasher par le flasher du booloader avec RESET, puis 4 (flash) et 1 (flash slots) pour flasher n'importe quel slot.
soit: ```bash -make OMEGA_USERNAME="" binpack -j4 +make OMEGA_USERNAME="{Votre nom, max 15 caractères}" binpack -j4 ``` -pour compiler les binpacks que vous pouvez distribuer et flasher depuis le [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0100/). - +pour compiler les binpacks que vous pouvez distribuer et flasher depuis le [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0100/). Vous les trouverez dans `output/release/device/bootloader/`.
+
- -Model n0110 (obsolète, utilisez le bootloader à la place, pas de protection contre Epsilon) +Model n0110 sans bootloader (obsolète, utilisez le bootloader à la place pour la protection contre Epsilon) +Compilez avec: ```bash make MODEL=n0110 clean -make MODEL=n0110 OMEGA_USERNAME="{Votre nom, maximum 15 caractères}" -j4 +make MODEL=n0110 OMEGA_USERNAME="{Votre nom, max 15 caractères}" -j4 ``` -Maintenant, lancez soit: +Ensuite lancez soit: ```bash make MODEL=n0110 epsilon_flash ``` -pour directement flasher la calculatrice après avoir appuyé simultanément sur `reset` et `6` et avoir branché la calculatrice à l'ordinateur. - +pour directement flasher la calculatrice après avoir appuyé simultanément sur `RESET` et `6` et avoir branché la calculatrice à l'ordinateur.
soit: ```bash -make MODEL=n0110 OMEGA_USERNAME="" binpack -j4 +make MODEL=n0110 OMEGA_USERNAME="{Votre nom, max 15 caractères}" binpack -j4 ``` -pour compiler les binpacks que vous pouvez distribuer et flasher depuis le [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0100/). +pour compiler les binpacks que vous pouvez distribuer et flasher depuis le [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0100/). Vous les trouverez dans `output/release/device/n0110/`. +
+ +
+ +Simulateur Natif + +Lancez cette commande: +```bash +make clean +``` +Vous pouvez soit choisir d'utiliser la commmande qui détectera automatiquement votre plateforme: +```bash +make PLATFORM=simulator +``` +Ou choisir une commande qui correspond à votre plateforme: +```bash +make PLATFORM=simulator TARGET=android +make PLATFORM=simulator TARGET=ios +make PLATFORM=simulator TARGET=macos +make PLATFORM=simulator TARGET=web +make PLATFORM=simulator TARGET=windows +make PLATFORM=simulator TARGET=3ds +``` + +Vous trouverez les fichiers du simulateur dans `output/release/simulator/`. + +
+ +
Simulateur web diff --git a/README.md b/README.md index f143d941d..e2187c199 100644 --- a/README.md +++ b/README.md @@ -71,22 +71,10 @@ And there you can go to step 2!
-To install basics dev tools: +To install all dependencies: ```bash -dnf install make automake gcc gcc-c++ kernel-devel -``` - -And then install required packages. - -```bash -install git ImageMagick libX11-devel libXext-devel freetype-devel libpng-devel libjpeg-devel pkg-config -``` - -Then, install GCC cross compiler for ARM. - -```bash - dnf install arm-none-eabi-gcc-cs arm-none-eabi-gcc-cs-c++ +dnf install make automake gcc gcc-c++ kernel-devel git ImageMagick libX11-devel libXext-devel freetype-devel libpng-devel libjpeg-devel pkg-config arm-none-eabi-gcc-cs arm-none-eabi-gcc-cs-c++ ```
@@ -285,7 +273,15 @@ to make binpack which you can flash to the calculator from [Ti-planet's webDFU](
-Model bootloader (N0110) +Model n0110 + +The bootloader allows you to install 2 firmware in separated "slots". If so, external apps won't have all the space but half. Bootloader will allow use of all of the memory if only one slot is flashed. In legacy mode, external apps use all the space available. + +
+Bootloader + +Your calculator must already have been flashed with [Upsilon](https://getupsilon.web.app)'s or [Omega](https://getomega.dev)'s bootloader. +Then, build with: ```bash make clean @@ -308,13 +304,13 @@ or: make OMEGA_USERNAME="" binpack -j4 ``` -to make binpack witch you can flash to the calculator from [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0110/). Binpacks are a great way to share a custom build of Upsilon to friends. - +to make binpack which you can flash to the calculator from [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0110/). You'll find them at `output/release/device/bootloader/`. Binpacks are a great way to share a custom build of Upsilon to friends.
-
-Model N0110 legacy (deprecated, use bootloader instead, no Epsilon protection) + +
+Model N0110 legacy (deprecated, use bootloader instead for Epsilon protection) ```bash make MODEL=n0110 clean @@ -337,10 +333,39 @@ or: make MODEL=n0110 OMEGA_USERNAME="" binpack -j4 ``` -to make binpack witch you can flash to the calculator from [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0110/). Binpacks are a great way to share a custom build of Upsilon to friends. +to make binpack which you can flash to the calculator from [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0110/). You'll find them at `output/release/device/bootloader/`. Binpacks are a great way to share a custom build of Upsilon to friends. +
+ +
+ +Native simulator + +Run this command: +```bash +make clean +``` +You can either build using the following command that will automatically detect your platform: +```bash +make PLATFORM=simulator +``` +or, choose the command corresponding to your platform: +```bash +make PLATFORM=simulator TARGET=android +make PLATFORM=simulator TARGET=ios +make PLATFORM=simulator TARGET=macos +make PLATFORM=simulator TARGET=web +make PLATFORM=simulator TARGET=windows +make PLATFORM=simulator TARGET=3ds +``` + +You'll find simulator files in `output/release/simulator/`. + +
+ +
Web simulator