diff options
| author | Front <27463495+Frontesque@users.noreply.github.com> | 2021-12-27 05:52:24 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-27 05:52:24 +0300 |
| commit | e313db4e77810a17120af3e1f1794116e9beca18 (patch) | |
| tree | 31eb51dabbd5f789f725f035d43cbd2e4eec73f0 | |
| parent | 58b718f02f63a742f32a81c070797bbf58d82302 (diff) | |
add compile guide to extension
| -rw-r--r-- | Extensions/combined/readme.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/Extensions/combined/readme.md b/Extensions/combined/readme.md new file mode 100644 index 0000000..ee827c0 --- /dev/null +++ b/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> |