From 8b0855d8842e0b77c969e27f0799840ea4618424 Mon Sep 17 00:00:00 2001 From: Nikolas Hagelstein Date: Fri, 28 Jul 2023 21:33:23 +0200 Subject: [PATCH] [FEATURE] Add contribution instructions to readme.md --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cabd24a0..65a4d35d 100644 --- a/README.md +++ b/README.md @@ -17,4 +17,22 @@ You can use Frontmatter to change layout and other settings per page: [https://v Inside the `docs` folder, you'll find several files and folders. The file `docs/blog/helloworld.md` will be rendered to `/blog/helloworld`, the `docs/blog/readme.md` will be rendered to `/blog/` -Images and other assets can be placed into the public dir. `docs/.vuepress/public/images/example.png` and be accessed in the browser via `/images/example.png`. \ No newline at end of file +Images and other assets can be placed into the public dir. `docs/.vuepress/public/images/example.png` and be accessed in the browser via `/images/example.png`. + +## Contribution +Piece of cake: +- File an issue +- File a corresponding pull request +- "I don't know what a pull request is!" : Just file an issue, we ll take good care of you. :) + +### Setting up a Development Environment to contribute + +#### Methode #1 +tl;dr: +- clone the repository +- run "yarn install" +- run "yarn dev" + +#### Methode #2 +You got a docker environment running anyway? Lovely: +- run docker compose up