cupper-hugo-theme/content/patterns/installation.md

53 lines
2.5 KiB
Markdown
Raw Normal View History

2017-06-27 21:15:38 +02:00
+++
title = "Installation"
2017-08-02 10:23:48 +02:00
weight = 1
2017-06-27 21:15:38 +02:00
+++
**Infusion** is built using the static site engine, [Hugo](https://gohugo.io/), and NPM. The codebase is available to download on Github. Let's get set up step-by-step.
2017-07-14 18:32:32 +02:00
## Install Hugo
2017-06-27 21:15:38 +02:00
2017-07-17 16:21:46 +02:00
First you need to install Hugo globally.
2017-06-27 21:15:38 +02:00
### OSX users
If you are a Mac user and have [Homebrew](https://brew.sh/) on your system, installing Hugo is simple:
{{<cmd>}}brew install hugo{{</cmd>}}
Alternatively, you can manually [install Hugo from a package](https://github.com/gohugoio/hugo/releases). You can verify the installation was successful by typing:
{{<cmd>}}hugo version{{</cmd>}}
### Windows users
Installing on Windows is a bit more involved than on OSX. The authors of Hugo provide [a guide](https://gohugo.io/tutorials/installing-on-windows/) with instructions for technical and less technical users.
2017-08-06 15:13:11 +02:00
It's also best you install a Windows Subsystem for running Linux, and therefore [bash](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) (**Infusion** incorporates some bash commands in its scripts). [Microsoft offer a complete guide](https://msdn.microsoft.com/en-gb/commandline/wsl/install_guide).
2017-07-14 18:32:32 +02:00
## Install Node & NPM
2017-06-27 21:15:38 +02:00
2017-07-03 13:23:53 +02:00
It is likely you already have Node and NPM installed on your system. If so, you can skip this step. Otherwise, [refer to NPM's own guide](https://docs.npmjs.com/getting-started/installing-node), which includes a video tutorial.
2017-06-27 21:15:38 +02:00
2017-07-17 16:21:46 +02:00
## Get the files
2017-06-27 21:15:38 +02:00
2017-08-07 23:20:49 +02:00
**Infusion** is hosted on Github. To start using it, you'll need to get the files from there. If you are comfortable with the command line, just fork the [github.com/ThePacielloGroup/infusion](https://github.com/ThePacielloGroup/infusion) repository, then do a `git clone` to your local system. Replace `[your username]` in the following:
2017-06-27 21:15:38 +02:00
2017-07-01 12:48:01 +02:00
{{<cmd>}}git clone https://github.com/[your username]/infusion.git{{</cmd>}}
2017-06-27 21:15:38 +02:00
2017-08-07 23:20:49 +02:00
If the command line is not your thing, fork [github.com/ThePacielloGroup/infusion](https://github.com/ThePacielloGroup/infusion) and choose **Open in Desktop** from **Clone or download** (see figure 1, below).
2017-06-27 21:15:38 +02:00
{{% figure caption="The Github web interface" %}}
![The open in desktop option, revealed when clicking clone or download](/images/open_in_desktop.png)
{{% /figure %}}
{{% note %}}
If you do not have a version of the Github desktop client installed, follow the prompts after clicking **Open in Desktop**.
{{% /note %}}
Once you have your local copy of the files, move to the root of that folder and in your terminal run an npm installation:
{{<cmd>}}npm install{{</cmd>}}
2017-06-28 11:34:21 +02:00
Now it's time to consult the {{% pattern "Library setup" %}} pattern.