chore(hugo): adjusted README

This commit is contained in:
Stephan Lo 2024-08-28 17:20:57 +02:00
parent 7197520e31
commit 361c0fe4a1

View file

@ -13,11 +13,11 @@ The repo contains a [Hugo `.devcontainer`-defintion](https://containers.dev/) so
To get a locally running documentation editing and presentation environment, follow these steps:
1. open a terminal on your local box
1. clone this repo: `git clone https://bitbucket.telekom-mms.com/scm/ipceicis/ipceicis-developerframework.git `
1. change to the repo working dir: `cd ipceicis-developerframework`
1. open the repo in an [Devcontainer-aware tool/IDE](https://containers.dev/supporting) (e.g. `code .`)
1. start the `devcontainer` (in VSC it's `F1 + Reopen in Devcontainer`)
1. when the container is up & running just open your browser with `http://localhost:1313/`
2. clone this repo: `git clone https://bitbucket.telekom-mms.com/scm/ipceicis/ipceicis-developerframework.git `
3. change to the repo working dir: `cd ipceicis-developerframework`
4. open the repo in an [Devcontainer-aware tool/IDE](https://containers.dev/supporting) (e.g. `code .`)
5. start the `devcontainer` (in VSC it's `F1 + Reopen in Devcontainer`)
6. when the container is up & running just open your browser with `http://localhost:1313/`
### Editing
@ -35,16 +35,16 @@ After having finished a unit of work commit and push.
When you run the above installation, the outputs could typically look like this:
### Steps 1-5 in the terminal
### Steps 1-4 in the terminal
![terminal](.devcontainer/terminal.png)
### Steps 5 and 6 in Visual Studio Code
### Steps 5/6 in Visual Studio Code
![vsc-f1](.devcontainer/vsc-f1.png)
![vsc-hugo](.devcontainer/vsc-hugo.png)
### Steps 7 in a web browser
### Steps 6 in a web browser
![browser](.devcontainer/browser.png)