Skip to content

Commit

Permalink
Merge pull request #9 from Omega-Numworks/docusaurus
Browse files Browse the repository at this point in the history
sync from upstream
  • Loading branch information
Alerymin authored Feb 19, 2024
2 parents 14eeaa5 + 619a81e commit bdc0fad
Show file tree
Hide file tree
Showing 30 changed files with 287 additions and 278 deletions.
2 changes: 1 addition & 1 deletion docs/cfw/install-epsilon-from-softloader.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,4 +51,4 @@ It's recommended to keep your Custom OS in Slot A.

### GG

You now have Epsilon and your Custom OS at the same time, Epsilon on one slot, your Custom OS on the other. You can now switch between them whenever you want, it works differently depending on your Custom OS but the goal is just to switch between slots.
You now have Epsilon and your Custom OS at the same time, Epsilon on one slot, your Custom OS on the other. You can now switch between them whenever you want, it works differently depending on your CFW's bootloader but the goal is just to switch between slots.
10 changes: 7 additions & 3 deletions docs/cfw/upsilon.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,19 @@ Upsilon tends to crash when you start it while the calculator is connected to a

### Section III - How to use your new calculator (not for N0100)

There are new features to your calculator now, which you need to know.
There are new features to your calculator now, which you need to know.<br/>
There is a new "Slot" system. Your calculator has 2 slots and can store 2 firmwares, they can't be run at the same time, but by using RESET you can switch between them.
Upsilon adds a bootloader, accessed by simply pressing RESET. Upsilon's bootloader consists of a menu that can do multiple useful things.

In this menu you can:
- Choose your slot. There are 3 in total, 2 of which can store a standard firmware. You can select them by pressing 1 for Slot A or 3 for Slot B. The 3rd, selected by pressing 2, is meant for very specific use cases, most people don't need it.
- Choose your slot. There are 3 in total, 2 of which can store a standard firmware. You can select them by pressing 1 for Slot A and 3 for Slot B. The 3rd slot, selected by pressing 2, is meant for very specific use cases, most people don't need it.
- By pressing 4 you can open Install mode. There are 2 options: Flash Slots (press 1), that allows you to safely install any other firmware on your calculator, and Flash Bootloader (press 2), that allows you to update the bootloader by getting you to recovery mode (it may not work, to access recovery mode you can still use 6 + RESET).

Also note that once plugged into the PC, (unless in recovery mode) your calculator will be named "Upsilon Calculator" or "Upsilon Bootloader" instead of the usual "NumWorks Calculator".
:::note

Once plugged into the PC, (unless in recovery mode) your calculator may be named "Upsilon Calculator" or "Upsilon Bootloader" instead of the usual "NumWorks Calculator".

:::

### Section IV - How to update Upsilon ?

Expand Down
2 changes: 1 addition & 1 deletion docs/credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Special thanks to:
- M4x1m3, the original creator of the guide.
- Rathmox for completing the guide.
- WonderHunter for the french translation.
- Rathmox and BloomyInDev for porting the guide to Docusaurus.
- Rathmox and BloomyInDev for porting the guide to [Docusaurus](https://docusaurus.io/).
:::

If we forgot you here, [contact us](https://github.com/Omega-Numworks/Omega-Guide) and we will add your name.
Expand Down
18 changes: 9 additions & 9 deletions docs/flowchart.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ flowchart TD
model_number ---->|N0115 or N0120| calc_locked_new_calcs
model_number --Other--> goto_discord([Go to Omega Discord server])
click model_number "./intro"
click calc_locked_no_modif "./unlock/what-to-do-locked"
click calc_unlocked "./cfw/choose-a-cfw"
click model_number "intro"
click calc_locked_no_modif "unlock/what-to-do-locked"
click calc_unlocked "cfw/choose-a-cfw"
click goto_discord "https://discord.gg/X2TWhh9"
subgraph n0110 [Branch N0110]
Expand All @@ -41,13 +41,13 @@ flowchart TD
install_18_2_0 --> phi
phi & hardware_method --> calc_unlocked_n0110
click check_version_n0110 "./unlock/n0110-is-locked"
click downgrade_check "./unlock/phi/check-version-change-eligibility"
click install_18_2_0 "./unlock/phi/install-epsilon-18-2-0"
click check_version_n0110 "unlock/n0110-is-locked"
click downgrade_check "unlock/phi/check-version-change-eligibility"
click install_18_2_0 "unlock/phi/install-epsilon-18-2-0"
click phi "./unlock/phi"
click hardware_method "./unlock/hardware/n0110-hardware-unlock"
click calc_locked_n0110 "./what-to-do-locked"
click calc_unlocked_n0110 "./cfw/choose-a-cfw"
click hardware_method "unlock/hardware/n0110-hardware-unlock"
click calc_locked_n0110 "what-to-do-locked"
click calc_unlocked_n0110 "cfw/choose-a-cfw"
end
Expand Down
3 changes: 2 additions & 1 deletion docs/how-does-it-work.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ So we can make 2 categories:
:::note

Every calculator, thanks to the MCU, has a recovery mode. It can usually be accessed by holding 6 while the calculator is starting (on N0100 it has to be plugged into a PC when it starts, you don't need to hold 6). It's represented by a black screen with the LED turned on red. But if you try to access the recovery mode, it may not behave like this, we will understand why later.
On N0115, Recovery Mode is not accessible this way.

:::

Expand Down Expand Up @@ -91,7 +92,7 @@ The process in the guide is now easy to understand:

### 7 - Why can the N0120 not be unlocked ?

The N0120 is a particular model:
The N0120 is a particular model:<br/>
It can be unlocked with a hardware modification, but the reason why we don't advertize it in this guide is because there is no Custom OS you can install on it.

The N0120 was released first with Epsilon 16, but a patched version that can't be unlocked with Phi. So there is no N0120 that can currently be unlocked without hardware.
Expand Down
6 changes: 3 additions & 3 deletions docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,6 @@ If you don't want to deeply modify your calculator, [there are still a few thing

| Calculator Model | What to do |
|------------------|-------------------------------------------------------------------------------------------------|
| N0100 | [Your calculator is already unlocked. Choose a Custom OS](./cfw/choose-a-cfw) |
| N0110 | [Check if your calculator is locked](./unlock/n0110-is-locked) |
| N0115 - N0120 | [You can't install a Custom OS on it. But there are still a few things you can do](./unlock/what-to-do-locked) |
| N0100 | [Your calculator is already unlocked. Choose a Custom OS](/docs/cfw/choose-a-cfw) |
| N0110 | [Check if your calculator is locked](/docs/unlock/n0110-is-locked) |
| N0115 - N0120 | [You can't install a Custom OS on it. But there are still a few things you can do](/docs/unlock/what-to-do-locked) |
4 changes: 2 additions & 2 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ It means the driver or config file isn't installed on Windows or Linux.

Open the [Rescue page](https://numworks.com/rescue/) on NumWorks' website and it will give it and tell you how to install it. **Don't plug in your calculator to make sure you don't lock it.**

If you are using Linux, it may still not be detected. It can happen if your web browser is installed as a flatpak.
If you are using Linux, it may still not be detected. It can happen if your web browser is installed as a flatpak or snap.

In this case, you will need to install [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal), select your web browser, and add `/run/udev` in the "Other files" into the "Filesystem" category.
If you're using flatpak, you will need to install [Flatseal](https://flathub.org/apps/com.github.tchx84.Flatseal), select your web browser, and add `/run/udev` in the "Other files" into the "Filesystem" category.

You can also run this command: `flatpak override --user --filesystem=/run/udev [Application ID]` (Replace `[Application ID]` with your web browser's ID, try to run `flatpak list` to find it).

Expand Down
2 changes: 1 addition & 1 deletion docs/unlock/hardware/n0110-hardware-unlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ There are multiple methods.

We recommend [this post](https://tiplanet.org/forum/viewtopic.php?f=113&t=25191&p=263495), it is very complete and will guide you very well.

If you have another way to get to Recovery mode, you can follow it instead.<br/>**We are not responsible for anything that goes wrong with your device**.
If you have another way to get to Recovery mode, you can follow it instead.<br/>**We are not responsible for anything that goes wrong with your device.**

2 changes: 1 addition & 1 deletion docs/unlock/n0110-is-locked.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Press the RESET button at the back of the calculator to return to the firmware.

#### Section III - Select a Method {#principal-methods}

Use the version table below to select a method. A few things to note:
Use the version table below to select a method.<br/>A few things to note:
+ The version table below is *inclusive*. For example, "from 16.3.0 to 18.0.0" includes 16.3.0, 18.0.0, and all versions in between.
+ Version 16.4.3 does not follow this rule.

Expand Down
2 changes: 1 addition & 1 deletion docs/unlock/what-to-do-locked.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Once you enable exam mode or press "RESET" they will be disabled.
Epsilon is still partially open-source, you can modify the code to create your own version and install it, however it's userland only and if you reset it will be removed and you are back to stock. You will also have a popup telling you that you are running a modified software.
Note that since Epsilon 16, sharing a modified version is illegal. You should never share the version you created yourself.

[NumWorks' instructions](https://www.numworks.com/resources/engineering/software/build/)
In order to build an OS in userland, you can follow [NumWorks' instructions](https://www.numworks.com/resources/engineering/software/build/).
6 changes: 3 additions & 3 deletions i18n/fr/code.json
Original file line number Diff line number Diff line change
Expand Up @@ -277,13 +277,13 @@
"message": "OS Custom"
},
"home.page.cfw.text1": {
"message": "Les OS Custom sont des modifications logicielles pour la NumWorks. Ces modifications vous permettent de faire tout ce qu'il est possible physiquement avec la NumWorks, et pas seulement ce que NumWorks décide ce qu'il est possible de faire avec son matériel"
"message": "Les OS Custom sont des modifications logicielles pour la NumWorks. Ces modifications vous permettent de faire tout ce qu'il est possible physiquement avec la NumWorks, et pas seulement ce que NumWorks décide ce qu'il est possible de faire avec son matériel."
},
"home.page.cfw.text2": {
"message": "Les utilisation communes des OS Custom sont:"
},
"home.page.cfw.possibilities.1": {
"message": "Éxecuter des logiciels et jeux fait-maison (Homebrew) fait ou portés sur la NumWorks"
"message": "Exécuter des logiciels et jeux fait-maison (Homebrew) fait ou portés sur la NumWorks"
},
"home.page.cfw.possibilities.2": {
"message": "Installer des applications comme des émulateurs"
Expand Down Expand Up @@ -328,7 +328,7 @@
"message": "Les méthodes utilisées ici sont à leur débuts. Il y a une petite chance que ces méthodes briquent votre calculatrice. Nous ne sommes dans aucun cas responsable de tout problème lié à votre calculatrice."
},
"home.page.whatKnow.text2": {
"message": "Ce guide est compatible avec tout les modèles de calculatrices Numworks vendus"
"message": "Ce guide est compatible avec tous les modèles de calculatrices NumWorks vendus."
},
"home.page.goto.guide": {
"message": "Démarrer"
Expand Down
2 changes: 1 addition & 1 deletion i18n/fr/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"description": "The label for category Unlock before installation in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Unlock before installation.link.generated-index.description": {
"message": "Comment débloquer sa Numworks pour installer un OS Custom",
"message": "Comment débloquer sa NumWorks pour installer un OS Custom",
"description": "The generated-index page description for category Unlock before installation in sidebar tutorialSidebar"
},
"sidebar.tutorialSidebar.category.Installing an OS": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ pagination_prev: null

:::info

Vous avez besoin d’une calculatrice débloquée. [Pour la débloquer continuez ici](/docs/intro)
Vous avez besoin d’une calculatrice débloquée. [Pour la débloquer continuez ici](/docs/intro).

:::

Il y a plusieurs OS Custom que vous pouvez installer sur votre calculatrice, la plupart s’installent de la même manière. En voici certains
Il y a plusieurs OS Custom que vous pouvez installer sur votre calculatrice, la plupart s’installent de la même manière. En voici certains :

| OS | Avantages |
|-----|-----------|
| [Omega](/docs/cfw/omega) | L'OS Custom le plus populaire pour Numworks, basé sur Epsilon 15.5.0. Il restaure le calcul symbolique, permet l'installation d'applications externes, et ajoute des libraries Python |
| [Omega](/docs/cfw/omega) | L'OS Custom le plus populaire pour NumWorks, basé sur Epsilon 15.5.0. Il restaure le calcul symbolique, permet l'installation d'applications externes, et ajoute des bibliothèques Python |
| [Upsilon](/docs/cfw/upsilon) | Basé sur Omega, Upsilon apporte plus de fonctions et de confort comparé à Omega, comme une liseuse LaTeX, plus de stockage pour les scripts Python, et un meilleur bootloader |
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,43 @@ pagination_prev: cfw/choose-a-cfw
---

:::danger
Suivre ce guide peut mettre en danger votre calculatrice. Installer Epsilon de la mauvaise manière sur votre calculatrice pourrait la bloquer.. Suivez **STRICTEMENT** ce qui est dit sur cette page pour être sur que votre calculatrice n'est pas en danger
Suivre ce guide peut mettre en danger votre calculatrice. Installer Epsilon de la mauvaise manière sur votre calculatrice pourrait la bloquer.. Suivez **STRICTEMENT** ce qui est dit sur cette page pour être sur que votre calculatrice n'est pas en danger.
:::

:::caution
La dernière version d'Epsilon pourrait ne pas être sûre, vérifiez la dernière version. Dernière version sûre connue: **22.2.0**
La dernière version d'Epsilon pourrait ne pas être sûre, vérifiez la dernière version. Dernière version sûre connue: **22.2.0**.
:::

:::info
Cette page est inutile si vous avez une n0100, étant donné que vous pouvez changer entre un CFW et Epsilon sans bloquer votre calculatrice. La n0100 n'est pas compatible avec les bootloader custom.
Cette page est inutile si vous avez une N0100, étant donné que vous pouvez changer entre un CFW et Epsilon sans bloquer votre calculatrice. La N0100 n'est pas compatible avec les bootloaders custom.
:::

### Lecture obligatoire

Nous allons maintenant installer Epsilon sur un slot de la calculatrice, en considérant que vous avez un bootloader qui le permet
Nous allons maintenant installer Epsilon sur un slot de la calculatrice, en considérant que vous avez un bootloader qui le permet.

### Ce dont vous avez besoin

- Un PC avec un navigateur basé Chromium (on recommande d'utiliser directement [chromium](https://www.chromium.org/chromium-projects/))
- Un bootloader custom compatible installé (si vous ne savez pas, regardez [cette page](/docs/cfw/choose-a-cfw))
- Un PC avec un navigateur basé Chromium (on recommande d'utiliser directement [chromium](https://www.chromium.org/chromium-projects/)).
- Un bootloader custom compatible installé (si vous ne savez pas ce que c'est ou n'êtes pas sûr d'en avoir un, regardez [cette page](/docs/cfw/choose-a-cfw)).

### Section I - Ouvrir le bootloader

Si votre CFW inclut un bootloader qui permet d'installer un firmware depuis celui-ci, vous devriez donc ouvrir le bootloader et le rendre prêt à installer quoi que ce soit. De l'aide eut être trouvée sur [cette page](/docs/cfw/choose-a-cfw)
Si votre CFW inclut un bootloader qui permet d'installer un firmware depuis celui-ci, vous devriez donc ouvrir le bootloader et le rendre prêt à installer quoi que ce soit. De l'aide peut être trouvée sur [cette page](/docs/cfw/choose-a-cfw).

### Section II - Installation

1. Vérifiez que votre calculatrice est dans le bootloader, prête à installer quoi que ce soit. Elle **NE DOIT PAS** être en mode Recovery (écran noir + LED rouge) étant donné que ça permettrait à Numworks de bloquer votre calculatrice
2. Ouvrez la [page de mise à jour Numworks](https://numworks.com/update)
3. Suivez les instructions mais si il vous demande de faire quoi que ce soit sur votre calculatrice, ne le faites pas à moins que ce soit la connecter à votre PC. Le site devrait voir la version 0.0.0
4. À la fin l'installer sera bloqué et pourrait donner une erreur, c'est car il ne peut pas redémarrer la calculatrice. Ne vous inquiétez pas Epsilon est installé, appuyez juste sur reset et tout est bon
1. Vérifiez que votre calculatrice est dans le bootloader, prête à installer quoi que ce soit. Elle **NE DOIT PAS** être en mode Recovery (écran noir + LED rouge) étant donné que ça permettrait à NumWorks de bloquer votre calculatrice.
2. Ouvrez la [page de mise à jour Numworks](https://numworks.com/update).
3. Suivez les instructions du site, cependant s'il vous demande de faire quoi que ce soit sur votre calculatrice, ne le faites pas à moins que ce soit de la connecter à votre PC. Le site devrait voir la version 0.0.0.
4. À la fin l'installeur sera bloqué et affichera peut-être un message d'erreur, c'est car il ne parvient pas à redémarrer la calculatrice. Ne vous inquiétez pas, Epsilon est installé, appuyez simplement sur RESET et tout est bon.

Maintenant vous avez Epsilon avec un bootloader custom donc votre calculatrice n'est pas bloquée
Maintenant vous avez Epsilon avec un bootloader custom donc votre calculatrice n'est pas bloquée.

Epsilon a normalement été installé sur les deux slots. Donc si vous aviez un CFW, il a été effacé, seul le bootloader reste. Pour le réinstaller vous pouvez le faire normalement depuis le bootloader ou en mode Recovery, faites juste attention de ne pas installer Epsilon à la place.
Epsilon a normalement été installé sur les deux slots. Donc, si vous aviez un CFW, il a été effacé, et seul son bootloader reste. Pour le réinstaller vous pouvez le faire comme la première fois depuis le bootloader ou en mode Recovery, cependant si vous choisissez de le faire en mode Recovery faites attention de ne pas installer Epsilon à la place, car cela bloquerait votre calculatrice à nouveau.

Il est recommandé de garder votre CFW en Slot A.

### GG

Vous avez maintenant Epsion et un CFW en même temps, Epsilon sur un slot, votre CFW sur l'autre. Vous pouvez maintenant changer quand vous voulez, cela fonctionne différemment en fonction de votre CFW mais l'objectif est juste de changer entre les deux slots.
Vous avez maintenant Epsilon et un CFW en même temps, Epsilon sur un slot, votre CFW sur l'autre. Vous pouvez maintenant changer quand vous voulez, cela fonctionne différemment en fonction du bootloader de votre CFW, mais l'objectif est juste de changer entre les deux slots.
Loading

0 comments on commit bdc0fad

Please sign in to comment.