2024/02/10 - Some project logistics for README.md

orbitmines · Jan 10, 2024 · 0e04eba · 0e04eba
1 parent 967da3a
commit 0e04eba
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -43,3 +43,19 @@ A simple way of phrasing this, is that the concept of a (hyper-/)'Vertex', (hype
 
 > [!WARNING]
 > No proper performance optimizations have been done on its current iteration.
+
+---
+
+### Local setup
+
+- Running `orbitmines.com` locally on `http://localhost:3000`:
+  - ```
+    npm install
+    ```
+  - ```
+    npm start
+    ```
+- Running tests.
+  - ```shell
+    npm run test -- --watchAll
+    ```
diff --git a/src/@orbitmines/external/chyp/Chyp.ts b/src/@orbitmines/external/chyp/Chyp.ts
@@ -8,4 +8,5 @@
  * **Why is this interface here?**
  *
  * Note that this is mainly here for reference to the existing Chyp codebase - for anyone who understands that structure, to quickly translate that knowledge into how Rays work. - Other than that functionality, everything here should be considered as deprecated. Or considered as a legacy translation, which will be accessibly through OrbitMines.
- */
+ */
+