diff --git a/README.md b/README.md index 759889515eeab4c831c56c51b00735e0bfd650bc..5eb54800d52b1f7185e9ade10cc69162f1a89d93 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,36 @@ - - # VuePress GitLab pages template This repo contains all the starter files for running VuePress on GitLab pages. -If you want to read more on VuePress, [check out their website](https://vuepress.vuejs.org/). \ No newline at end of file +If you want to read more on VuePress, [check out their website](https://vuepress.vuejs.org/). + +## Running locally + +This project uses [yarn](), you'll need to install this globally before you can get started. + +``` +npm install -g yarn +``` + +Then you need to install the project dependencies: + +``` +yarn install +``` + +Now you're ready to go. +To run the local dev server just use the following command: + +``` +yarn start +``` + +## Building the site + +[.gitlab-ci.yml](./.gitlab-ci.yml) takes care of the deployment to GitLab pages. +If you want to preview a build locally, you can run: + +``` +yarn build +``` + +This will build all your files into a `./public` directory. \ No newline at end of file