Added in set PATH and new site output.

I added in the instructions for how to add the hugo.exe to the PATH variable.  And I added in example output post new site command.

[close #1058]
This commit is contained in:
Bill Traynor 2015-04-13 23:04:03 -04:00 committed by spf13
parent a52e508d46
commit feba35cd1f

View file

@ -43,17 +43,18 @@ One advantage of building Hugo in go is that there is just a single binary file
5. You should see a `hugo_0.13_windows_amd64.exe` file.
6. Rename that file to `hugo.exe`.
7. Verify that the `hugo.exe` file is in the `D:\Hugo\bin` folder. (It's possible that the extract put it in a sub-directory. If it did, use Windows Explorer to move it to `D:\Hugo\bin`.)
8. Add the hugo.exe executable to your PATH with: `D:\Hugo\bin>set PATH=%PATH%;D:\Hugo\bin`
## Verify the executable
Run a few commands to verify that the executable is ready to run and then build a sample site to get started.
1. Open a command prompt window.
2. At the prompt, type `D:\Hugo\bin\hugo help` and press the Enter key. You should see output that starts with:
2. At the prompt, type `hugo help` and press the Enter key. You should see output that starts with:
```
A Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. Complete documentation is available at http://gohugo.io
```
If you do, then the installation is complete. If you don't, double-check the path that you placed the `hugo.exe` file in and that you typed that path correctly. If you're still not getting the output, post a note on the Hugo discussion list (in the `Support` topic) with your command and the output.
If you do, then the installation is complete. If you don't, double-check the path that you placed the `hugo.exe` file in and that you typed that path correctly when you added it to your PATH variable. If you're still not getting the output, post a note on the Hugo discussion list (in the `Support` topic) with your command and the output.
3. At the prompt, change your directory to the `Sites` directory.
```
C:\Program Files> cd D:\Hugo\Sites
@ -62,15 +63,30 @@ D:\Hugo\Sites>
```
4. Run the command to generate a new site. I'm using `example.com` as the name of the site.
```
D:\Hugo\Sites> D:\Hugo\bin\hugo new site example.com
D:\Hugo\Sites> hugo new site example.com
```
Note that you must type the full path to `hugo` unless you've updated your system PATH variable!
5. You should get output similar to the following: `TODO: grab output and put here` You now have Hugo installed and a site to work with. You need to add a layout (or theme), then create some content. Go to http://gohugo.io/overview/quickstart/ for steps on doing that.
5. You should now have a directory at D:\Hugo\Sites\example.com. Change into that directory and list the contents. You should get output similar to the following:
```
D:\Hugo\Sites>cd example.com
D:\Hugo\Sites\example.com>dir
Directory of D:\hugo\sites\example.com
04/13/2015 10:44 PM <DIR> .
04/13/2015 10:44 PM <DIR> ..
04/13/2015 10:44 PM <DIR> archetypes
04/13/2015 10:44 PM 83 config.toml
04/13/2015 10:44 PM <DIR> content
04/13/2015 10:44 PM <DIR> data
04/13/2015 10:44 PM <DIR> layouts
04/13/2015 10:44 PM <DIR> static
1 File(s) 83 bytes
7 Dir(s) 6,273,331,200 bytes free
```
You now have Hugo installed and a site to work with. You need to add a layout (or theme), then create some content. Go to http://gohugo.io/overview/quickstart/ for steps on doing that.
## Troubleshooting
@dhersam has a nice video on common issues at https://www.youtube.com/watch?v=c8fJIRNChmU
## Future Steps
Consider adding `D:\Hugo\bin` to your system PATH.