Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
m-lilja committed Jan 23, 2024
1 parent d1bb198 commit 5fb6955
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,15 +32,8 @@ theme-gem, please edit the regexp in `swedbankpay.gemspec` accordingly.

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.
6. Verify that Git is installed by running `git status` in VSC terminal.
If Git is not properly installed, you will see an error message like the one below. Just [download Git][git] and install.
![Alt text](image.png)
7. Once Docker and Git are installed, run `bundle install` in VSC terminal.
8. If needed, run `bundle update`.
9. Run `bundle exec jekyll serve` to start the website.
3. Open a console window at the root of the repository and run `docker-compose up`. This will create a docker container.
4. Open Docker Desktop and start the container if not already running.
10. Open `http://localhost:4000` in a browser.

Check warning on line 37 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L37

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


Expand All @@ -52,10 +45,19 @@ theme-gem, please edit the regexp in `swedbankpay.gemspec` accordingly.
3. To install the [Ruby Gems][gems] this web site requires, you first need to
install [Bundler][bundler].
4. Install [Graphviz][graphviz], this will require Java.
5. Run Visual Studio Code (VSC) and open the repository.
6. Verify that Git is installed by running `git status` in VSC terminal.
If Git is not properly installed, you will see an error message like the one below. Just [download Git][git] and install.
![Alt text](image.png)
5. Once Ruby ,Bundler, and Graphviz, is in place, type `bundle install` inside the root
folder of this repository.

Check warning on line 53 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L53

Marker should be `7`, was `5` ordered-list-marker-value remark-lint
Raw output
   52:1-53:31  warning  Marker should be `7`, was `5`   ordered-list-marker-value   remark-lint
6. Run `bundle exec jekyll serve` to start the website.

Check warning on line 54 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L54

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

Check warning on line 55 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L55

Marker should be `9`, was `7` ordered-list-marker-value remark-lint
Raw output
   55:1-55:23  warning  Marker should be `9`, was `7`   ordered-list-marker-value   remark-lint

Check warning on line 55 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L55

Remove 1 line after node no-consecutive-blank-lines remark-lint
Raw output
        55:23  warning  Remove 1 line after node        no-consecutive-blank-lines  remark-lint


### Visual Studio Code plugins

You might want to install plugins for Markdown, Mermaid, JSON and Liquid as this will enhance your coding experience.


## Contributing

Check warning on line 63 in README.md

View workflow job for this annotation

GitHub Actions / remark-lint

[remark-lint] README.md#L63

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

0 comments on commit 5fb6955

Please sign in to comment.