installation instructions

freespek · Apr 15, 2024 · 693dfec · 693dfec
1 parent 0359a22
commit 693dfec
Showing 1 changed file with 30 additions and 0 deletions.
diff --git a/solarkraft/INSTALL.md b/solarkraft/INSTALL.md
@@ -0,0 +1,30 @@
+# Solarkraft Runtime Monitoring
+
+## Installing the development version
+
+ 1. Install NodeJS 20.x. We recommend using
+ [nvm](https://github.com/nvm-sh/nvm).
+
+ 1. Install dependencies:
+
+    ```sh
+    npm install
+    ```
+
+ 1. Compile:
+
+    ```sh
+    npm run compile
+    ```
+
+ 1. Install a local version:
+
+    ```sh
+    npm link
+    ```
+
+ 1. Run the CLI:
+
+    ```sh
+    solarkraft
+    ```