Software setup for Windows - roman-gardens/gre GitHub Wiki

The following steps are demonstrated in this short video: GRE software setup for Windows

VSCode

VSCode is a powerful text editor that integrates with GitHub and also has a built-in terminal for running Hugo commands. GRE editors use VSCode to create and edit garden articles.

Download VSCode from https://code.visualstudio.com/
Run VSCode
If you see the "welcome" page, you can
- Uncheck the box at the bottom that says "Show welcome page on startup"
- Close the "Welcome" tab

Git

Git is a version control system that tracks changes to files. VSCode provides a graphical user interface for tracking changes, but requires Git behind the scenes.

In VSCode, go to the "View" menu, select "Terminal", and enter the following command
- winget install --id Git.Git -e --source winget
Close and restart VSCode (this is necessary for the following commands to work)
Set your name and e-mail address with the following commands (use the same e-mail that you use to sign up for GitHub below)
- git config --global user.name "John Doe"
- git config --global user.email [email protected]

Hugo

Hugo is a static website generator. GRE editors use Hugo to preview the website on their local computer before contributing their edits to the project.

In the VSCode terminal, enter the following command
- winget install Hugo.Hugo
Test your installation by entering
- hugo version

If it says it doesn't recognize the command, try restarting VSCode and running the hugo version command again.

Note: In the future, whenever we need upgrade to a newer version of Hugo, we can use the command winget upgrade hugo

GitHub

The "Gardens of the Roman Empire" (GRE) project files are hosted on GitHub. To make contributions to GRE, you will need a (free) GitHub account.