readme and starter

README.md

@@ -1 +1,10 @@
-# The site is made using Hugo static site generator
+# Portfolio Template
+
+Work in progress.
+
+This is a [Hugo](https://gohugo.io) website template designed for personal portfolio.
+
+To make changes to the theme locally, you need NPM and Hugo installed. Then:
+
+- Read [STARTER](/STARTER.md) for reference
+

STARTER.md

@@ -0,0 +1,43 @@
+# To Run Locally
+
+## Step 1: Install Hugo
+
+```bash
+brew install hugo
+# or
+port install hugo
+
+# To verify your new install:
+hugo version
+```
+
+## Step 2: Clone the Repo
+
+```bash
+git clone [email protected]:Abusayid693/Hugo-Portfolio-.git
+```
+
+## Step 3: Start the server
+
+```bash
+cd Hugo-Portfolio
+# Start hugo server
+hugo server
+
+# Navigate eg : http://localhost:61491
+```
+
+# For Compiling SCSS (if you modify SCSS)
+We have compiled SCSS file seperately using npm package node-sass
+
+## Step 1: Install Node Modules
+
+```bash
+npm install
+```
+
+## Step 2: Start SCSS compiler
+
+```bash
+npm run compile:sass
+```