Browse Source

add compile guide to extension

Front 3 years ago
parent
commit
e313db4e77
1 changed files with 16 additions and 0 deletions
  1. 16 0
      Extensions/combined/readme.md

+ 16 - 0
Extensions/combined/readme.md

@@ -0,0 +1,16 @@
+# Extension Source
+## Guide to Compiling
+
+## Compiling to Development (Testing)
+<ol>
+    <li>Go to the root directory of the project</li>
+    <li>Run <code>npm i</code> to install all project dependancies (if not done so already)</li>
+    <li>run <code>npm run dev</code> to compile the extension to the <code>~/Extensions/combined/dist/</code> folder.</li>
+</ol>
+
+## Compiling to Production (Final Release)
+<ol>
+    <li>Go to the root directory of the project</li>
+    <li>Run <code>npm i</code> to install all project dependancies (if not done so already)</li>
+    <li>run <code>npm run build</code> to compile the extension to the <code>~/Extensions/combined/dist/</code> folder.</li>
+</ol>