diff --git a/README.md b/README.md index 47e2431..6c2484a 100644 --- a/README.md +++ b/README.md @@ -184,8 +184,19 @@ See the basic `post` file params supported by the theme — https://github.com/p ## How to run your site +The theme is using [Hugo Pipes](https://gohugo.io/hugo-pipes/) to handle Javascript and PostCSS files. This setup **requires** following npm packages: `@babel/core`, `@babel/cli` and `postcss-cli`. Before you start, you have to install them (globally or locally): + From your Hugo root directory run: +``` +yarn add -D @babel/core @babel/cli @postcss-cli +cd themes/terminal +yarn +cd ../.. +``` + +Then: + ``` $ hugo server -t terminal ``` @@ -195,20 +206,7 @@ and go to `localhost:1313` in your browser. From now on all the changes you make ## How to edit the theme If you have to override some of the styles, **you can do this easily** by adding `static/style.css` in your root directory and point things you want to change. - -Otherwise, if you really want to edit the theme, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory): - -``` -$ cd themes/terminal -``` - -and then run: - -``` -$ npm install -$ npm i yarn -$ yarn -``` +But you can also copy `assets` folder from the theme to your root directory and modify the files. This will protect your changes from the override when you update the theme. ## How to contribute