Merge pull request Omega-Numworks#50 from Rathmox/docusaurus

Docusaurus migration

.github/workflows/docusaurus_deploy.yml

@@ -0,0 +1,50 @@
+name: Deploy static content to Pages
+
+on:
+    # Runs on pushes targeting the default branch
+    push:
+        branches: ['docusaurus']
+
+    # Allows you to run this workflow manually from the Actions tab
+    workflow_dispatch:
+
+# Sets the GITHUB_TOKEN permissions to allow deployment to GitHub Pages
+permissions:
+    contents: read
+    pages: write
+    id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+    group: 'pages'
+    cancel-in-progress: true
+
+jobs:
+    # Single deploy job since we're just deploying
+    deploy:
+        environment:
+            name: github-pages
+            url: ${{ steps.deployment.outputs.page_url }}
+        runs-on: ubuntu-latest
+        steps:
+            - name: Get the repo (checkout)
+              uses: actions/checkout@v3
+            - name: Set up Node
+              uses: actions/setup-node@v3
+              with:
+                  node-version: 18
+                  cache: 'npm'
+            - name: Install dependencies
+              run: npm install
+            - name: Build
+              run: npm run build
+            - name: Setup Pages
+              uses: actions/configure-pages@v3
+            - name: Upload artifact
+              uses: actions/upload-pages-artifact@v1
+              with:
+                  # Upload dist repository
+                  path: './build'
+            - name: Deploy to GitHub Pages
+              id: deployment
+              uses: actions/deploy-pages@v1

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules\\typescript\\lib"
+}

docs/cfw/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Installing an OS",
+  "position": 5,
+  "link": {
+    "type": "generated-index",
+    "description": "What is possible with a Custom OS"
+  }
+}

docs/cfw/choose-a-cfw.md

@@ -0,0 +1,19 @@
+---
+title: "Choose a Custom OS"
+sidebar_position: 1
+pagination_next: null
+pagination_prev: null
+---
+
+:::info
+
+You need an unlocked calculator. [To unlock it go here](../intro)
+
+:::
+
+There are multiple Custom OSs you can install on your calculator, most of them install in the same way. Here are a few of them
+
+|           OS                | Advantages                                                                                                                                                      |
+|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| [Omega](/docs/cfw/omega)     | The most popular Custom OS for Numworks, forked from Epsilon 15.5.0. It bings back symbolic calculation, allows installing external apps, and adds Python libraries   |
+| [Upsilon](/docs/cfw/upsilon) | Forked from Omega, Upsilon brings more features and conveience compared to Omega, like a LaTeX reader, more storage for Python scripts, and a better bootloader |

docs/cfw/install-epsilon-from-softloader.md

@@ -0,0 +1,54 @@
+---
+title: "Install Epsilon from softloader"
+sidebar_position: 4
+pagination_next: null
+pagination_prev: cfw/choose-a-cfw
+---
+
+:::danger
+
+Following this guide may put your calculator at risk. Installing Epsilon on your calculator the wrong way may lock it. **STRICTLY** follow what's said on this page to make sure your calculator is safe
+
+:::
+
+:::caution
+
+The latest Epsilon version may not be safe, check the latest version. Latest known safe version: **21.2.0**
+
+:::
+
+:::info
+
+This page is irrelevant if you have an n0100, because you can switch between any Custom OS and Epsilon without locking your calculator. And the n0100 can't have any custom bootloader.
+
+:::
+
+### Required Reading
+
+We will now install Epsilon on one slot of your calculator, assuming you have a bootloader that allows it
+
+### What You Need
+
+- A PC with a chromium-based browser (we recommend using [chromium](https://www.chromium.org/chromium-projects/) directly)
+- A compatible custom bootloader installed (if you don't know, see [this page](/docs/cfw/choose-a-cfw))
+
+### Section I - Open the bootloader
+
+If your Custom OS includes a custom bootloader that allows installing a firmware from it, you should now open the bootloader and make it ready to install anything. Some help can be found on [this page](/docs/cfw/choose-a-cfw)
+
+### Section II - Install
+
+1. Make sure your calculator is in the bootloader, ready to install anything. It **MUST NOT** be in recovery mode (black screen + red led) as this would allow Numworks to lock your calculator.
+2. Open [Numworks' Update page](https://numworks.com/update)
+3. Follow instructions but if it asks you to do anything on your calculator, don't do it unless it's connecting it to your PC. The website should see version 0.0.0
+4. At the end the installer will get stuck and may even fail, it's because it can't reboot the calculator. Don't worry Epsilon is installed, just press reset and you are good
+
+Now you have Epsilon with a custom bootloader so your calculator isn't locked.
+
+Epsilon has normally been installed on both slots. So if you had a Custom OS, it has been erased, only the bootloader is remaining. To reinstall it you can do it normally from the bootloader or in recovery mode, just make sure you are not installing Epsilon again.
+
+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.

docs/cfw/omega.md

@@ -0,0 +1,76 @@
+---
+title: "Omega"
+sidebar_position: 2
+pagination_next: null
+pagination_prev: cfw/choose-a-cfw
+---
+
+:::info
+
+You need an unlocked calculator. [To unlock it go here](/docs/intro)
+
+:::
+
+This page will explain how to install Omega, assuming you have an unlocked calculator
+
+### What you need
+
+- A PC with a chromium based browser (we recommend using [chromium](https://www.chromium.org/chromium-projects/) directly)
+- An unlocked Numworks calculator
+
+### Section I - Prepare recovery mode
+
+if your model is n0110, enter recovery mode by holding "6" and pressing "reset"
+if your model is n0100, enter recovery mode by plugging your calculator and pressing reset
+
+### Section II - Install Omega
+
+1. Open [Omega website](https://getomega.dev/install)
+2. Click "Recovery" and select "STM32 BOOTLOADER"
+3. Wait a bit until the calculator shows "Recovery Mode" on the screen
+4. If the calculator doesn't get automatically connected, click "Detect Calculator" and select "Numworks Calculator"
+5. Now you can click "Install Omega" and in a few seconds Omega should be installed on your calculator.
+
+### Section III - How to use your new calculator (not for n0100)
+
+There are new features to your calculator now, you need to know them
+There is a new "Slot" system. Your calculator has 2 slots and can store 2 firmwares, they can't run at the same time but by using reset you can switch between them:
+- Hold 1 and press reset to start Slot A (containing Omega by default)
+- Hold 2 and press reset to start Slot B (may be empty or contains Epsilon)
+- Hold 4 and press reset to open the bootloader, you will be able to see which slot contain which firmware and also be able to install any firmware without locking the calculator.
+- You can’t start another firmware if you enable exam mode, you have to disable it to do so
+
+### Section IV - How to update ?
+
+To update Omega, open the bootloader by holding 4 and pressing reset, plug your calculator in your PC, go to the Omega website, and install it normally.
+
+To update the bootloader, access recovery mode by pressing reset while holding 6, plug the calculator in your PC, go to the Omega website, connect your calculator in Recovery mode and install Omega this way.
+
+### Optional features
+
+Now that Omega is installed, there are a few steps you can take:
+
+#### External apps (not for n0100)
+
+Omega support external apps, there are a few but they are useful. Here is how to install them:
+1. Open [External apps page](https://external.getomega.dev/)
+2. Select the apps you want to install
+3. Add any file you may need to use with your apps
+4. Add a wallpaper if you want
+5. Enable icons support to have good looking icons on your apps
+6. Click install
+
+#### Installing Epsilon (not for n0100)
+
+You can install Epsilon on the bootloader without locking the calculator.
+
+See [Install Epsilon from softloader](/docs/cfw/install-epsilon-from-softloader)
+
+
+#### Create your own version
+
+Omega is open-source, you can get the code and use it however you want. You will find everything on [Omega's github repo](https://github.com/Omega-Numworks/Omega)
+
+### Finished
+
+You now have Omega installed on your calculator. You can add python scripts in the same way as before from [Numworks' workshop](https://my.numworks.com/python/)

docs/cfw/upsilon.md

@@ -0,0 +1,94 @@
+---
+title: "Upsilon"
+sidebar_position: 3
+pagination_next: null
+pagination_prev: cfw/choose-a-cfw
+---
+
+:::info
+
+You need an unlocked calculator. [To unlock it go here](/docs/intro)
+
+:::
+
+This page will explain how to install Upsilon, assuming you have an unlocked calculator
+
+### What you need
+
+- A PC with a chromium based browser (we recommend using [chromium](https://www.chromium.org/chromium-projects/) directly)
+- An unlocked Numworks calculator
+
+### Section I - Prepare recovery mode
+
+if your model is n0110, enter recovery mode by holding "6" and pressing "reset"
+if your model is n0100, enter recovery mode by plugging your calculator and pressing reset
+
+### Section II - Install Upsilon
+
+1. Open [Upsilon website](https://getupsilon.web.app/install)
+2. Click "Recovery" and select "STM32 BOOTLOADER"
+3. Wait a bit until the calculator shows "Recovery Mode" on the screen
+4. If the calculator doesn't get automatically connected, click "Connect" and select "Numworks Calculator"
+5. Select your settings like the theme. For the slot, if you don't know which one to choose, select "A"
+6. Now you can click "Install Upsilon" and in a few seconds Upsilon should be installed on your calculator.
+
+:::tip
+
+Upsilon tends to crash when you start it and the calculator is connected to a PC. Disconnect it before starting
+
+:::
+
+### Section III - How to use your new calculator (not for n0100)
+
+There are new features to your calculator now, you need to know them
+There is a new "Slot" system. Your calculator has 2 slots and can store 2 firmwares, they can't run at the same time but by using reset you can switch between them.
+You now have a menu on boot, it allows you do to a lot. You can acces it just by pressing "reset".
+
+In this menu you can:
+- Choose your slot. There are 3, 2 of them can recieve 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.
+- Open Install mode. There are 2 modes: Flash Slots, that allows you to safely install any other firmware on your calculator, and Flash Bootloader, 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 "NumWorks Calculator".
+
+### Section IV - How to update ?
+
+To update Upsilon, open Install Mode and Flash Slots (see above how to), plug your calculator in your PC, go to the Upsilon website, and install it normally.
+
+To update the bootloader, access recovery mode by pressing reset while holding 6, plug the calculator in your PC, go to the Upsilon website, connect your calculator in Recovery mode and install Upsilon this way.
+
+### Optional features
+
+Now that Upsilon is installed, there are a few steps you can take:
+
+#### External apps (not for n0100)
+
+Upsilon support external apps, there are a few but they are useful. Here is how to install them:
+1. Open [External apps page](https://upsilonnumworks.github.io/Upsilon-External/)
+2. Select the apps you want to install
+3. Add any file you may need to use with your apps
+4. Add a wallpaper if you want
+5. Click install
+
+#### Reader (not for n0100)
+
+Upsilon has a reader app. It can display text files and LaTeX expressions.
+
+Any file with the `.txt` extension can be read, however if you want to use LaTeX expressions, you need to change the extension to `.urt`. What is inside the file stays the same but Upsilon will display LaTeX expressions.
+All the LaTeX expressions are documented [here](https://getupsilon.web.app/doc/reader).
+
+To transfer your file, send it through the [External apps page](https://upsilonnumworks.github.io/Upsilon-External/).
+
+#### Installing Epsilon (not for n0100)
+
+You can install Epsilon on the bootloader without locking the calculator.
+
+See [Install Epsilon from softloader](/docs/cfw/install-epsilon-from-softloader)
+
+
+#### Create your own version
+
+Upsilon is open-source, you can get the code and use it however you want. You will find everything on [Upsilon's github repo](https://github.com/UpsilonNumworks/Upsilon)
+
+### Finished
+
+You now have Upsilon installed on your calculator. You can add python scripts in the same way as before from [Numworks' workshop](https://my.numworks.com/python/)

docs/credits.md

@@ -0,0 +1,28 @@
+---
+sidebar_position: 99
+title: "Credits"
+pagination_next: null
+pagination_prev: null
+---
+
+:::note
+Special thanks to:
+- M4x1m3, the original creator the guide
+- Rathmox for completing the guide.
+- WonderHunter for the french translation
+- Rathmox and BloomyInDev for porting the guide to docusaurus
+:::
+
+If we forgot you here, [contact us](https://github.com/Omega-Numworks/Omega-Guide) and we will add your name.
+
++ AngeDieu
++ BloomyInDev
++ darthnithin
++ hdboye
++ M4x1m3
++ orkeilius
++ Rathmox
++ siim0n
++ Syycorax
++ TomVdt
++ WonderHunter

docs/faq.md

@@ -0,0 +1,31 @@
+---
+sidebar_position: 98
+title: "FAQ"
+pagination_next: null
+pagination_prev: null
+---
+
+# Pre-Installation FAQ
+
+**Q:** *Will this guide void my warranty ?*
+
+**A:** No, at least not in europe. This is a software modification, if Numworks
+refuses you a legitimate warranty claim after that, sue the fuck out of them.
+
+**Q:** *How risky is jailbreaking my Numworks?*
+
+**A:** Full on hardware bricks are quasi-impossible. The worst you can get is a
+calculator with write protection enabled with an empty flash, which can always be solved
+with a hardware mod, but the chance of having that kind of issue is very very unlikely.
+
+**Q:** *Can I do this without a computer (e.g. an Android phone)?*  
+
+**A:** All you need is a device capable of running a web browser supporting WebUSB. Android
+phones can be used with an USB OTG cable.
+
+# Post-Installation FAQ
+
+**Q:** *Is it safe to update Epsilon while having a Custom OS installed ?*
+
+**A:** At the moment, Numworks' installer doesn't check for modded bootloaders, neither does
+Epsilon, so yes (unless you don't have a bootloader which is probably not the case).