Add Windows setup instructions

This commit is contained in:
ace 2023-05-02 00:41:40 +01:00
parent b584f604b6
commit 198eb6b7c4

View file

@ -1,20 +1,69 @@
# Setup notes
## Required Software
## Setup
### Required Software
- bash terminal
- hugo
- ssh
- git
- rsync
### Windows setup
#### Install and run git-bash
1. Download and install Git for Windows
This can be downloaded from https://git-scm.com/download/win
Make sure to install "git-bash" during the setup process"
2. Open git-bash
search for git-bash from the start menu and open it
#### Set up SSH key
1. Set up SSH key for connecting to the server
```
ssh-keygen -t ed25519 -C "your_email@example.com"
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519
```
2. Copy your public key and add it to the Git repository account
To view the public key, type the following
```
cat ~/.ssh/id_ed25519.pub
```
3. Clone the repository
```
mkdir project-folder
cd project-folder
git clone --recursive git@git.disroot.org:ace/hugo-demo.git
cd hugo-demo
```
4. Install Hugo
```
./install/git-bash.sh
```
5. Run setup script
```
./setup.sh
```
## Workflow
Initial setup
git clone --recursive [git@git.disroot.org](mailto:git@git.disroot.org):ace/hugo-demo.git
cd hugo-demo
./setup.sh
Start local test server
./test.sh