From a0afbe9916fb5951eca93768fde5fdd67d3dc4e4 Mon Sep 17 00:00:00 2001 From: LeMoustachu Date: Wed, 2 Feb 2022 22:19:36 +0100 Subject: [PATCH] Update building docs and french readme (#136) --- README.fr.md | 294 +++++++++++++++++++++++++++++++++++------- README.md | 60 +++++---- docs/build/index.md | 307 ++++++++++++++++++++++++++++++++++++++++---- 3 files changed, 564 insertions(+), 97 deletions(-) diff --git a/README.fr.md b/README.fr.md index 58555c9c808..d30ce8eedd5 100644 --- a/README.fr.md +++ b/README.fr.md @@ -26,74 +26,275 @@ Upsilon est un fork d'Omega, un fork d'Epsilon, l'OS de Numworks tournant sur le ## Installation ### Site web -Rendez-vous sur le [site d'Upsilon](https://lolocomotive.github.io/Upsilon-website) à la section "Installer". +Rendez-vous sur le [site d'Upsilon](https://lolocomotive.github.io/Upsilon-website) à la section "Installer". Si votre calculatrice est reconnue, qu'elle contient une version d'Epsilon inférieure à 16 et que votre navigateur accepte WebUSB, la page vous proposera d'installer Upsilon. Ne débranchez votre calculatrice qu'une fois l'installation terminée. ### Manuelle -Tout d'abord, suivez **la première étape** [ici](https://www.numworks.com/resources/engineering/software/build/), puis : + *Vous pouvez vous référer à ce [site internet](https://www.numworks.com/resources/engineering/software/build/)pour la première étape si vous avez des erreurs* + + + +### 1. Installation du SDK + +
+ +
+ +1.1 Linux + +
+
- Modèle n0100 -(note : vous pouvez changer `EPSILON_I18N=fr` en `en`, `nl`, `pt`, `it`, `de`, `es` ou `hu`). +Debian ou Ubuntu + +
+ +Il suffit juste d'installer les dépendances en tapant ces commandes dans un Terminal en mode super-utilisateur. ```bash -git clone --recursive https://github.com/Lauryy06/Upsilon.git -cd Upsilon -git checkout omega-master -make MODEL=n0100 clean -make MODEL=n0100 EPSILON_I18N=fr OMEGA_USERNAME="{Votre nom ici, 15 caractères max}" -j4 -make MODEL=n0100 epsilon_flash +apt-get install build-essential git imagemagick libx11-dev libxext-dev libfreetype6-dev libpng-dev libjpeg-dev pkg-config gcc-arm-none-eabi binutils-arm-none-eabi ``` -Important : N'oubliez pas l'argument `--recursive`, Upsilon a besoin de sous-modules. -Vous pouvez aussi changer le nombre de processus parallèles pendant la compilation en changeant la valeur suivant `-j`. +C'est fait! Vous pouvez aller à l'étape 2. + +
- Modèle n0110 + +Fedora + +
+ +Installez tout d'abord des outils de développement. ```bash -git clone --recursive https://github.com/Lauryy06/Upsilon.git -cd Upsilon -git checkout omega-master -make clean -make OMEGA_USERNAME="{Votre nom ici, 15 caractères max}" -j4 -make epsilon_flash +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++ ``` -Important : N'oubliez pas l'argument `--recursive`, Upsilon a besoin de sous-modules. -Vous pouvez aussi changer le nombre de processus parallèles pendant la compilation en changeant la valeur suivant `-j`. +
+ +
- Fichiers binaires - -Ces fichiers peuvent être utilisés pour distribuer Upsilon (pour que tout le monde puisse le flasher via [Webdfu_Numworks](https://ti-planet.github.io/webdfu_numworks/)). + +1.2 Mac + +
+ +Il est recommandé d'utiliser [Homebrew](https://brew.sh/). Une fois intsallé, utilisez: +```bash +brew install numworks/tap/epsilon-sdk +``` +Et toutes les dependances seront installées. + +
+ +Vous pouvez aller à l'étape 2. + +
+ +
+ +
+ +1.3 Windows + +[Git](http://git-scm.com) doit être installé. + +
+ +
+ +Avec Msys2/Mingw (Supportés par Numwoks bien qu'il y ait beaucoup de bugs) + +L'environnement de compilation [Msys2](https://www.msys2.org/) est recommandé par Numworks pour obtenir la plupart des outils requis facilement. C'est ici que vous allez copier-colletoutes lecommandes de ce tutoriel. Une fois installé, copier-coller ces deux commandes dans le terminal: + +```bash +pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-freetype mingw-w64-x86_64-pkg-config mingw-w64-x86_64-libusb git make python +echo "export PATH=/mingw64/bin:$PATH" >> .bashrc +``` + +Ensuite, vous devrez installer [GCC toolchain for ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). Quand il vouest demandde choisir u dossier d'installation, choisissez `C:\msys64\home\User\gcc-arm\`. Il vous faudra ensuite ajouter ce dossier à votre $PATH. Tapez juste: + +```bash +echo "export PATH=$PATH:$HOME/gcc-arm/bin" >> .bashrc +``` +Redémarrez votre terminal et vous pouvez aller à l'étape 2! + +
+ +
+ +Avec WSL 2 + +WSL est un système qui virtualise un environnement GNU/Linux dans Windows. + +Votre version de windows doit être >= 1903. + +#### Installation de WSL + +1. Apuyez simulatanément sur les touches "windows" et "x" puis cliquez sur "Powershell administrateur". Entrez ensuite ceci dans la nouvelle fenêtre: +```powershell +dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux all /norestart +``` +Cette commande active WSL + +```powershell +dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart +``` +Cette commande permet d'autoriser le démarrage des machines signées par Microsoft. + +2. Redémarrez votre ordinateur. + +3. Téléchargez ce fichier [this file](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi) et suivez les instructions d'installation. + +4. Ouvrez votre fenêtre powershell comme avant et tapez: +```powershell +wsl --set-default-version 2 +``` +5. téléchargez [Ubuntu](https://www.microsoft.com/store/apps/9n6svws3rx71) depuis le Microsoft store. Vous pouvez aussi installer [Debian](https://www.microsoft.com/store/productI9MSVKQC78PK6). + +WSL est maintenant installé. + +### Installation d'usbipd pour connecter la calculatrice à WSL (facultatif) +Pour connecter la calculatrice, il faut installer cet [outil](https://github.com/dorssel/usbipd-win/releases/download/v1.3.0/usbipd-win_1.3.0.msi). Il permet de connecter deperiphériques USpar internet.Suivez les instructions pour installer. + +#### Ubuntu +1. Dans un terminal WSL Ubuntu, tapez: +```bash +sudo apt install linux-tools-5.4.0-77-generic hwdata +``` +2. Editez /etc/sudoers pour que l'on puisse utiliser la commande usbip. Sur Ubutu, cele est fait de cette manière: +```bash +sudo visudo +``` +3. Ajoutez `/usr/lib/linux-tools/5.4.0-77-generic` au début du secure_path. Après édition, la ligne devrait ressembler à: +`Defaults secure_path="/usr/lib/linux-tools/5.4.0-77-generic:/usr/local/sbin:..."` + +#### Debian +1.Si vous utiliser Debian, utilisez cette commande: +```bash +sudo apt install usbip hwdata usbutils +``` + +### Pour connecter la calculatrice à WSL +1. Ouvrez encore un powershell en mode administrateur et tapez: +```powershell + usbipd wsl list +``` +Ceci va lister les périphériques USB connectés à l'ordinateur. Reagrdez le BUSID de votre "Numworks Calculator". + +2. Maintenant, lancez cette commande en remplçant par celui de votre caculatrice: +```powershell +usbipd wsl attach --busid +``` + +Le mot de passe de votre machine WSL vous sera demandé. + +Vous pouvez aller à l'étape 2. + +
+ +
+ +
+ +### 2. Récupérer le code source + + +Le code source est disponible dans une repository git. Récupérez-le de cette manière: ```bash git clone --recursive https://github.com/Lauryy06/Upsilon.git cd Upsilon -git checkout omega-master +git checkout upsilon-dev +``` +
+ + +### 3. Choisissez le système à compiler + + +
+ +Model n0100 + +(note: vous pouvez changer l'argument `EPSILON_I18N=en` avec `fr`, `nl`, `pt`, `it`, `de`, `es` or `hu`). + +```bash +make MODEL=n0100 clean +make MODEL=n0100 EPSILON_I18N=en OMEGA_USERNAME="{Votre nom, maximum 15 caractères}" -j4 +``` + +Maintenant, lancez soit: + +```bash +make MODEL=n0100 epsilon_flash +``` +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=n0100 OMEGA_USERNAME="" 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/). + +
+ +
+ +Model n0110 + +```bash make clean -make MODEL=n0100 OMEGA_USERNAME="" -j8 -make MODEL=n0100 OMEGA_USERNAME="" binpack -j8 -make OMEGA_USERNAME="" -j8 -make OMEGA_USERNAME="" binpack -j8 +make OMEGA_USERNAME="{Votre nom, maximum 15 caractères}" -j4 +`` + +Maintenant, lancez soit: + +```bash +make epsilon_flash +``` +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 OMEGA_USERNAME="" 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/). -Important : N'oubliez pas l'argument `--recursive`, Upsilon a besoin de sous-modules. -Vous pouvez aussi changer le nombre de processus parallèles pendant la compilation en changeant la valeur suivant `-j`. -
- Simulateur web - + +Simulateur web + D'abord, installez emsdk : ```bash @@ -107,24 +308,20 @@ source emsdk_env.sh Puis, compilez Upsilon : ```bash -git clone --recursive https://github.com/Lauryy06/Upsilon.git -cd Upsilon -git checkout omega-master make clean -make PLATFORM=simulator TARGET=web OMEGA_USERNAME="{Votre nom ici, 15 caractères max}" -j4 +make PLATFORM=simulator TARGET=web OMEGA_USERNAME="{Votre nom, maximum 15 caractères}" -j4 ``` Le simulateur se trouve dans `output/release/simulator/web/simulator.zip` -Important : N'oubliez pas l'argument `--recursive`, Upsilon a besoin de sous-modules. -Vous pouvez aussi changer le nombre de processus parallèles pendant la compilation en changeant la valeur suivant `-j`.
- Simulateur 3DS - -Vous aurez besoin de devkitPro et de devkitARM disponible dans votre `$PATH` (instructions [ici](https://devkitpro.org/wiki/Getting_Started) (en anglais)) + +Simulateur pour 3DS + +Il vous faut devkitPro et devkitARM installés et dans votre path (les instructions sont [ici](https://devkitpro.org/wiki/Getting_Started)) ```bash git clone --recursive https://github.com/Lauryy06/Upsilon.git @@ -132,15 +329,20 @@ cd Upsilon git checkout --recursive upsilon-dev make PLATFORM=simulator TARGET=3ds -j ``` - -Vous pouvez ensuite copier epsilon.3dsx sur une carte SD pour l'exécuter depuis le HBC ou utiliser 3dslink pour le lancer via le réseau : +Vous pouvez ensuite mettre epsilon.3dsx sur une carte SDpour le lancer depuis le HBC ou utilisez 3dslink pour le lancer via le réseau: ```bash -3dslink output/release/simulator/3ds/epsilon.3dsx -a +3dslink output/release/simulator/3ds/epsilon.3dsx -a <3DS' IP ADDRESS> ```
+
+ +Important: n'oubliez pas l'argument `--recursive` Parce qu'Upsilon dépend de submodules. +Aussi, vous pouvez changer le nombre de processus de compilation en parallèles en changeant le nombre après l'argument `-j`. +N'oubliez pas de mettre votre nom à la place `{Votre nom, maximum 15 caractères}`.Si vous n'en voulez pas, enlevez l'argument `OMEGA_USERNAME`. + Si vous avez besoin d'aide, n'hésitez pas à rejoindre notre serveur discord : https://discord.gg/Q9buEMduXG

Omega Banner Discord

 diff --git a/README.md b/README.md index fb5f3144c39..592dbdbeee9 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ Upsilon is a fork of Omega, an user-made OS that runs on the Numworks calculator ### Installer -Go to the [Upsilon website](https://lolocomotive.github.io/Upsilon-website) to the "Install" section. +Go to the [Upsilon website](https://lolocomotive.github.io/Upsilon-website) to the "Install" section. If your calculator is recognized, contains a version of Epsilon lower than 16 and your browser accepts WebUSB, the page will suggest you to install Upsilon. Do not disconnect your calculator until the installation is complete. @@ -46,12 +46,13 @@ Do not disconnect your calculator until the installation is complete.
+ 1.1 Linux
-
+ Debian or Ubuntu
@@ -69,26 +70,27 @@ And there you can go to step 2!
+ Fedora
-First install basics dev tools. +To install basics dev tools: ```bash dnf install make automake gcc gcc-c++ kernel-devel ``` -Then install required packages. +And then install required packages. ```bash -dnf install git ImageMagick libX11-devel libXext-devel freetype-devel libpng-devel libjpeg-devel pkg-config +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 arm-none-eabi-gcc-cs arm-none-eabi-gcc-cs-c++ ```
@@ -100,14 +102,17 @@ dnf install arm-none-eabi-gcc-cs arm-none-eabi-gcc-cs-c++
+ 1.2 Mac
It's recommended to use [Homebrew](https://brew.sh/). Once it's installed, just run: + ```bash brew install numworks/tap/epsilon-sdk ``` + and it will install all dependencies.
@@ -116,24 +121,26 @@ And there you can go to step 2!
- -
+ 1.3 Windows
+
+ With Msys2/Mingw (officialized by numworks but with a lot of bugs) -[Msys2](https://www.msys2.org/) environment is recommended by Numworks to get most of the required tools on Windows easily. It's where you'll paste all the commands of this tutorial. Once it's installed, paste these commands into the Msys2 terminal. + +[Msys2](https://www.msys2.org/) environment is recommended by Numworks to get most of the required tools on Windows easily. It's where you'll paste all the commands of this tutorial. Once it'sinstalled, paste these commands into the Msys2 terminal. ```bash pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-freetype mingw-w64-x86_64-pkg-config mingw-w64-x86_64-libusb git make python echo "export PATH=/mingw64/bin:$PATH" >> .bashrc ``` -Next, you'll need to install the [GCC toolchain for ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). When prompted for an install location, choose `C:\msys64\home\User\gcc-arm\`. You'll then need to add this folder to your $PATH. Just enter: +Next, you'll need to install the [GCC toolchain for ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). When prompted for aninstall location, choose `C:\msys64\home\User\gcc-arm\`. You'll then need to add this folder to your $PATH. Just enter: ```bash echo "export PATH=$PATH:$HOME/gcc-arm/bin" >> .bashrc @@ -143,8 +150,8 @@ Just restart terminal and you can go to step 2!
-With WSL 2 +With WSL 2 You need a windows version >= 1903. @@ -168,13 +175,13 @@ This one allows virtual machines developed by Microsoft. 4. Now open powershell admin like before and type: ```powershell wsl --set-default-version 2 -``` + ``` 5. Download [Ubuntu](https://www.microsoft.com/store/apps/9n6svws3rx71) from Microsoft store. WSL is now installed. ### Usbipd installation to connect your calculator -If you want to connect to the calculator, you have to connect to install this [tool](https://github.com/dorssel/usbipd-win/releases/download/v1.3.0/usbipd-win_1.3.0.msi). This will allow you to connect WSL to the calculator through internet. Follow the on screen information to install. +If you want to connect to the calculator, you have to connect to install this [tool](https://github.com/dorssel/usbipd-win/releases/download/v1.3.0/usbipd-win_1.3.0.msi). This will allow you toconnect WSL to the calculator through internet. Follow the on screen information to install. #### Ubuntu 1. In a WSL Ubuntu command prompt, type: ```bash @@ -188,6 +195,7 @@ sudo visudo `Defaults secure_path="/usr/lib/linux-tools/5.4.0-77-generic:/usr/local/sbin:..."` #### Debian + 1. If you use debian for your WSL distro, use this command instead: ```bash sudo apt install usbip hwdata usbutils @@ -207,12 +215,14 @@ usbipd wsl attach --busid It will ask you to type your wsl's password and will connect your calculator to WSL. You can now go to step 2! +

+ ### 2. Set up repo @@ -230,7 +240,8 @@ git checkout upsilon-dev
- Model n0100 + +Model n0100 (note: you can change the `EPSILON_I18N=en` flag to `fr`, `nl`, `pt`, `it`, `de`, `es` or `hu`). @@ -253,12 +264,13 @@ or: ```bash make MODEL=n0100 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/n0100/). 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/n0100/). Binpacks are a great way to share a custom build of Upsilonto friends. +
- Model n0110 + +Model n0110 ```bash @@ -285,8 +297,9 @@ to make binpack witch you can flash to the calculator from [Ti-planet's webDFU](
- Web simulator - + +Web simulator + First, install emsdk : ```bash @@ -306,12 +319,12 @@ make PLATFORM=simulator TARGET=web OMEGA_USERNAME="{Your name, max 15 characters The simulator is now in `output/release/simulator/web/simulator.zip` -
- 3DS Simulator - + +3DS Simulator + You need devkitPro and devkitARM installed and in your path (instructions [here](https://devkitpro.org/wiki/Getting_Started)) ```bash @@ -347,7 +360,7 @@ If you need help, you can join our Discord server here : https://discord.gg/NFvz ## Contributing To contribute, please refer to [Omega's Wiki](https://github.com/Omega-Numworks/Omega/wiki/Contributing), the same rules apply here. - + ## Related repositories Here are the main links toward Omega's different websites and repositories, that have been used for the creation of Upsilon. @@ -378,4 +391,3 @@ NumWorks SAS and Nintendo of America Inc aren't associated in any shape or form * NumWorks Epsilon is released under a [CC BY-NC-SA License](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode). * Omega is released under a [CC BY-NC-SA License](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode). * Upsilon is released under a [CC BY-NC-SA License](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode). - diff --git a/docs/build/index.md b/docs/build/index.md index 1fd79621d34..dc3976b5a92 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -4,71 +4,324 @@ breadcrumb: SDK --- # Build and run your own version of Upsilon -## Install the SDK +### Manual -### Windows + *You can refer to this [website](https://www.numworks.com/resources/engineering/software/build/) for the first step if you get errors.* -We recommend using the [Msys2](https://www.msys2.org/) environment to install most of the required tools. We support Windows 7 and up. Once Msys2 has been installed, launch the Msys2 terminal application, and enter the following commands + +### 1. Install SDK + +
+ +
+ +1.1 Linux + +
+ +
+ +Debian or Ubuntu + +
+ +You just have to install dependencies by running these command with superuser privileges in a Terminal: + +```bash +apt-get install build-essential git imagemagick libx11-dev libxext-dev libfreetype6-dev libpng-dev libjpeg-dev pkg-config gcc-arm-none-eabi binutils-arm-none-eabi ``` -pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-freetype mingw-w64-x86_64-pkg-config mingw-w64-x86_64-libusb git make python -echo "export PATH=/mingw64/bin:$PATH" >> .bashrc + +And there you can go to step 2! + +
+ +
+ +
+ +Fedora + +
+ +To install basics dev tools: + +```bash +dnf install make automake gcc gcc-c++ kernel-devel ``` -Last but not least, download and install the latest [GCC toolchain from ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). When prompted for an install location, choose `C:\msys64\home\User\gcc-arm\`. You'll then need to add this folder to your $PATH in Msys2 by running this command: `echo "export PATH=$PATH:$HOME/gcc-arm/bin" >> .bashrc` and restarting Msys2. +And then install required packages. -### macOS +```bash +install git ImageMagick libX11-devel libXext-devel freetype-devel libpng-devel libjpeg-devel pkg-config +``` -We recommend using [Homebrew](https://brew.sh) to install all dependencies. Once you have installed Homebrew, install all the dependencies with the following command: +Then, install GCC cross compiler for ARM. +```bash + dnf install arm-none-eabi-gcc-cs arm-none-eabi-gcc-cs-c++ ``` + +
+ +
+ +
+ +
+ +
+ +1.2 Mac + +
+ +It's recommended to use [Homebrew](https://brew.sh/). Once it's installed, just run: + +```bash brew install numworks/tap/epsilon-sdk ``` -### Debian or Ubuntu +and it will install all dependencies. + +
+ +And there you can go to step 2! + +
+ +
+ +
-Most of the required tools are available as apt packages: +1.3 Windows +
+ +
+ +With Msys2/Mingw (officialized by numworks but with a lot of bugs) + +[Msys2](https://www.msys2.org/) environment is recommended by Numworks to get most of the required tools on Windows easily. It's where you'll paste all the commands of this tutorial. Once it'sinstalled, paste these commands into the Msys2 terminal. + +```bash +pacman -S mingw-w64-x86_64-gcc mingw-w64-x86_64-freetype mingw-w64-x86_64-pkg-config mingw-w64-x86_64-libusb git make python +echo "export PATH=/mingw64/bin:$PATH" >> .bashrc ``` -apt-get install build-essential git imagemagick libx11-dev libxext-dev libfreetype6-dev libpng-dev libjpeg-dev pkg-config + +Next, you'll need to install the [GCC toolchain for ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). When prompted for aninstall location, choose `C:\msys64\home\User\gcc-arm\`. You'll then need to add this folder to your $PATH. Just enter: + +```bash +echo "export PATH=$PATH:$HOME/gcc-arm/bin" >> .bashrc ``` +Just restart terminal and you can go to step 2! + +
+ +
+ +With WSL 2 -You'll also need to install the latest version of GCC and make it available in your $PATH: +You need a windows version >= 1903. -1. Download the [GCC toolchain distributed by ARM](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads). You should obtain a `gcc-arm-none-eabi-x-linux.tar.bz2` file. -2. Decompress that file with `tar xvfj gcc-arm-none-eabi-*-linux.tar.bz2` -3. Add the resulting folder to your $PATH. If you use bash, ``echo "export PATH=\$PATH:`find $(pwd)/gcc-arm-none-eabi-*-update/bin -type d`" >> ~/.bashrc`` should do what you need (you'll need to restart your terminal afterwards). +#### WSL Installation -Alternatively, on Debian 10 and later you can directly install a sufficiently modern cross-toolchain: +1. Use simultaneously win + X keys and then click on "admin powershell". +```powershell +dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux all /norestart ``` -apt-get install gcc-arm-none-eabi binutils-arm-none-eabi +This command activate WSL functionalities. + +```powershell +dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart ``` +This one allows virtual machines developed by Microsoft. + +2. Restart your computer. + +3. Download [this file](https://wslstorestorage.blob.core.windows.net/wslblob/wsl_update_x64.msi) and follow instructions. -## Retrieve the source code +4. Now open powershell admin like before and type: +```powershell +wsl --set-default-version 2 + ``` +5. Download [Ubuntu](https://www.microsoft.com/store/apps/9n6svws3rx71) from Microsoft store. -The code is hosted on GitHub. You can retrieve it using the following command. +WSL is now installed. +### Usbipd installation to connect your calculator +If you want to connect to the calculator, you have to connect to install this [tool](https://github.com/dorssel/usbipd-win/releases/download/v1.3.0/usbipd-win_1.3.0.msi). This will allow you toconnect WSL to the calculator through internet. Follow the on screen information to install. +#### Ubuntu +1. In a WSL Ubuntu command prompt, type: +```bash +sudo apt install linux-tools-5.4.0-77-generic hwdata ``` -git clone https://github.com/Lauryy06/Upsilon.git +2. Edit /etc/sudoers so that root can find the usbip command. On Ubuntu, run this command. +```bash +sudo visudo ``` +3. Add `/usr/lib/linux-tools/5.4.0-77-generic` to the beginning of secure_path. After editing, the line should look similar to this. +`Defaults secure_path="/usr/lib/linux-tools/5.4.0-77-generic:/usr/local/sbin:..."` -## Run Upsilon on your computer +#### Debian -Once the SDK has been installed, just open your terminal (Msys2, Terminal.app, xterm…) and type the following commands: +1. If you use debian for your WSL distro, use this command instead: +```bash +sudo apt install usbip hwdata usbutils +``` +And that's all for installation and set up. +### To connect your calculator +1. Open an Admin powershell and type: +```powershell + usbipd wsl list ``` -make PLATFORM=simulator clean -make PLATFORM=simulator epsilon_run +This will list your usb devices connected. Look at the BUSID column and remember the one for your calculator (it should be called "Numworks Calculator"). +2. Now run this command replacing by your calculator's usb port id: +```powershell +usbipd wsl attach --busid ``` +It will ask you to type your wsl's password and will connect your calculator to WSL. + +You can now go to step 2! + +
+ +
+ +
+ -## Run Upsilon on your calculator +### 2. Set up repo -You can also update your NumWorks calculator easily. Note that you'll need to press the Reset button and that all data on your calculator will be lost. +Clone repo and use 'upsilon-dev' branch by pasting these two commands: + +```bash +git clone --recursive https://github.com/Lauryy06/Upsilon.git +cd Upsilon +git checkout upsilon-dev +``` +
+ + +### 3. Choose the target + + +
+ +Model n0100 + +(note: you can change the `EPSILON_I18N=en` flag to `fr`, `nl`, `pt`, `it`, `de`, `es` or `hu`). + +```bash +make MODEL=n0100 clean +make MODEL=n0100 EPSILON_I18N=en OMEGA_USERNAME="{Your name, max 15 characters}" -j4 ``` + +Now, run either: + +```bash +make MODEL=n0100 epsilon_flash +``` +to directly flash the calculator after pressing simultaneously `reset` and `6` buttons and plugging in. + +
+ +or: + +```bash +make MODEL=n0100 OMEGA_USERNAME="" binpack -j4 +``` +to make binpack which you can flash to the calculator from [Ti-planet's webDFU](https://ti-planet.github.io/webdfu_numworks/n0100/). Binpacks are a great way to share a custom build of Upsilonto friends. + +
+ +
+ +Model n0110 + + +```bash make clean -make +make OMEGA_USERNAME="{Your name, max 15 characters}" -j4 +``` + +Now, run either: + +```bash make epsilon_flash ``` +to directly flash the calculator after pressing simultaneously `reset` and `6` buttons and plugging in. + +
+ +or: + +```bash +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. + +
+ +
+ +Web simulator + +First, install emsdk : + +```bash +git clone https://github.com/emscripten-core/emsdk.git +cd emsdk +./emsdk install latest-fastcomp +./emsdk activate latest-fastcomp +source emsdk_env.sh +``` + +Then, compile Upsilon : + +```bash +make clean +make PLATFORM=simulator TARGET=web OMEGA_USERNAME="{Your name, max 15 characters}" -j4 +``` + +The simulator is now in `output/release/simulator/web/simulator.zip` + +
+ +
+ +3DS Simulator + +You need devkitPro and devkitARM installed and in your path (instructions [here](https://devkitpro.org/wiki/Getting_Started)) + +```bash +git clone --recursive https://github.com/Lauryy06/Upsilon.git +cd Upsilon +git checkout --recursive upsilon-dev +make PLATFORM=simulator TARGET=3ds -j +``` +You can then put epsilon.3dsx on a SD card to run it from the HBC or use 3dslink to launch it over the network: + +```bash +3dslink output/release/simulator/3ds/epsilon.3dsx -a <3DS' IP ADDRESS> +``` + +
+ +
+ +Important: Don't forget the `--recursive` tag, because Upsilon relies on submodules. +Also, you can change the number of processes that run in parallel during the build by changing the value of the `-j` flag. +Don't forget to put your pseudo instead of `{your pseudo, max 15 char}`. If you don't want one, just remove the `OMEGA_USERNAME=""` argument. + +
Congratulations, you're running your very own version of Upsilon! + +To build with a special theme, please refer to this [page](../../themes/README.md). + +If you need help, you can join our Discord server here : https://discord.gg/NFvzdCBTQn + +

Omega Banner Discord