From 7e0f5c210f14b6dc628bbed65150ee2f38c71ec7 Mon Sep 17 00:00:00 2001 From: Karl Dreher Date: Mon, 22 May 2023 19:31:07 -0700 Subject: [PATCH] docs: update build docs --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1167985..91782b2 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,8 @@ should align to these tenants, or propose an adjustment to the tenants. - **Subnetting is design work.** Promote features that enhance visual clarity and easy mental processing of even the most complex architectures. - **Users control the data.** We store nothing, but provide convenient ways for users to save and share their designs. -- **Embrace community contributions.** Consider and respond to all feedback and pull requests in the context of these - tenants. +- **Embrace community contributions.** Consider and respond to all feedback and pull requests in the context of these + tenants. ## Building From Source @@ -32,12 +32,14 @@ Compile from source: ```shell # Clone the repository > git clone https://github.com/ckabalan/visualsubnetcalc +# Use reccomended NVM version +> nvm use # Change to the sources directory > cd visualsubnetcalc/src # Install Bootstrap > npm install -# Compile Bootstrap -> sass --style compressed scss/custom.scss:../dist/bootstrap.min.css +# Compile Bootstrap (Also install sass command line globally) +> npm run build ``` The full application should then be available within `./dist/`, open `./dist/index.html` in a browser.