Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updated README.md with more detailed Docker instructions
  • Loading branch information
m-lilja authored Jan 22, 2024
1 parent 2ccaea8 commit f1da9bc
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,22 @@ like to host it locally on your computer, you have two options, manual install
or [Docker][docker].
The Docker installation is the one we recommend to use for its simplicity.

### Docker

1. Install [Docker][docker], using Linux containers.
Make sure virtualization is enabled on your machine.
2. Open a console window at the root of the repository and run
`docker-compose up`
### Docker

Check warning on line 24 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L24

Remove 1 line before node no-consecutive-blank-lines remark-lint
Raw output
         24:1  warning  Remove 1 line before node       no-consecutive-blank-lines  remark-lint

### Manual install
1. [Clone this repository][clone].
2. [Install Docker Personal][docker]. Select default settings when prompted.
3. Open a console window at the root of the repository and run `docker-compose up`. This will create and run a docker container.
Everything specified in the repository `gemfile` will be installed and run in the container.
5. Run Visual Studio Code (VSC) and open the repository.

Check warning on line 30 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L30

Marker should be `4`, was `5` ordered-list-marker-value remark-lint
Raw output
   30:1-30:58  warning  Marker should be `4`, was `5`   ordered-list-marker-value   remark-lint
6. Verify that Git is installed by running `git status` in VSC terminal. If not installed, [download Git][git] and install.

Check warning on line 31 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L31

Marker should be `5`, was `6` ordered-list-marker-value remark-lint
Raw output
  31:1-31:125  warning  Marker should be `5`, was `6`   ordered-list-marker-value   remark-lint
7. Once Docker and Git are installed, run `bundle install` in VSC terminal.

Check warning on line 32 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L32

Marker should be `6`, was `7` ordered-list-marker-value remark-lint
Raw output
   32:1-32:77  warning  Marker should be `6`, was `7`   ordered-list-marker-value   remark-lint
8. If needed, run `bundle update`.

Check warning on line 33 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L33

Marker should be `7`, was `8` ordered-list-marker-value remark-lint
Raw output
   33:1-33:36  warning  Marker should be `7`, was `8`   ordered-list-marker-value   remark-lint
9. Run `bundle exec jekyll serve` to start the website.

Check warning on line 34 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L34

Marker should be `8`, was `9` ordered-list-marker-value remark-lint
Raw output
   34:1-34:57  warning  Marker should be `8`, was `9`   ordered-list-marker-value   remark-lint
10. Open `http://localhost:4000` in a browser.

Check warning on line 35 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L35

Marker should be `9`, was `10` ordered-list-marker-value remark-lint
Raw output
   35:1-35:47  warning  Marker should be `9`, was `10`  ordered-list-marker-value   remark-lint


### Manual install (instructions last updated 2021)

1. [Clone this repository][clone].
2. Jekyll is written in [Ruby][ruby], so you'll need to download and install
Expand Down Expand Up @@ -91,6 +99,7 @@ agreement][cla].
[developer-portal]: <https://developer.swedbankpay.com/>
[docker]: <https://www.docker.com/>
[gems]: <https://rubygems.org/>
[git]: <https://git-scm.com/downloads>
[github]: <https://github.com/SwedbankPay/swedbank-pay-design-guide-jekyll-theme>
[graphviz]: <https://graphviz.org/download/>
[license-badge]: https://img.shields.io/github/license/SwedbankPay/swedbank-pay-design-guide-jekyll-theme
Expand Down

0 comments on commit f1da9bc

Please sign in to comment.