From 4aeb99e0e2d373156c28997b1ab94bbf13baca6d Mon Sep 17 00:00:00 2001 From: stupidcomputer Date: Sun, 16 Jun 2024 20:14:49 -0500 Subject: [PATCH] add a section on running tests on the project --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6f9c679..09a3933 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,16 @@ In general: *embed the intelligence into the machine code, **not** the CPU/ISA!* - [x] Simplify the synchronization stack. - [ ] Write documentation for all of this. +## Running tests + +- Enter the nix-shell, then start a web browser. +- Navigate to `https://desmos.com/calculator`, and open the dev console +- Run `python3 -m cli sync -c` to copy the userscript to your clipboard +- Run the userscript in the console +- Run `main()` in the console +- Run `python3 -m unittest ./cli/tests/isa.py`, or other test groups if needed +- Keep the Desmos tab focused, as it may impede the ISA testing process + ## License This project is licensed under the AGPLv3. See the `LICENSE` file for more information.