diff --git a/README.md b/README.md index 3efa367..09400d3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,20 @@ # devfolio A simple, responsive, single-page portfolio for developers built with Bulma, Sass and Font Awesome. -[Demo here](https://mmacneil.github.io/devfolio/) +View the [demo here](https://mmacneil.github.io/devfolio/). + +## Setup + +1. Clone or fork this repository. +2. Install required dependencies from your terminal by running `npm install` from the project folder root containing `package.json`. +
+ src\>npm install
+3. Use webpack to compile and bundle the css/js by running `npm run build` from the project folder root containing `webpack.config.js`. Webpack will also begin watching these files for changes and re-build as they're modified. +
+ src\>npm run build
+ 4. Open `index.html` locally in your favorite browser. + 5. Modify accordingly - styles, colors and variables can be changed in `styles.scss`. Refer to the Bulma docs for guidance on how to quickly customize further to suit your tastes using [color helpers](https://bulma.io/documentation/modifiers/color-helpers/) and [variables](https://bulma.io/documentation/customize/variables/). + + ## Contact + markmacneil@gmail.com +