simplify contributions by fully automating the dev setup with gitpod.

picturepan2 · Mar 16, 2020 · d667331 · d667331
1 parent 32a1223
commit d667331
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -6,3 +6,4 @@ node_modules/
 !.gitattributes
 !.hound.yml
 !.scss-lint.yml
+!.gitpod.yml
diff --git a/.gitpod.yml b/.gitpod.yml
@@ -0,0 +1,2 @@
+tasks:
+  - init: yarn install
diff --git a/README.md b/README.md
@@ -42,6 +42,19 @@ Alternatively, you can use the [unpkg](https://unpkg.com/) or [cdnjs](https://cd
 
 You can compile your custom version of Spectre.css. Read [the documentation](https://picturepan2.github.io/spectre/getting-started/custom.html).
 
+## Contributing
+
+### Online one-click setup
+
+You can use Gitpod(a free online VS Code-like IDE) for contributing. With a single-click it'll launch a workspace and automatically:
+
+- clone the repo.
+- install the dependencies.
+
+so that you can start coding straight away.
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/from-referrer/)
+
 ## Documentation and examples
 
 ### Elements