From a26eef0d93756a7a0f86fb2bb8e24c68de763425 Mon Sep 17 00:00:00 2001 From: Mateusz Pusz Date: Fri, 1 Oct 2021 11:27:01 +0200 Subject: [PATCH] docs: docs updated for gitpod --- CONTRIBUTING.md | 10 +++++++++- README.md | 2 ++ 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ac93c7ec..ea7e89c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,17 @@ 👍🎉 First off, thanks for taking the time to contribute! 🎉👍 +## Gitpod + +The easiest way to start coding is to jump streight into [Gitpod](https://www.gitpod.io). You can either click the button +below or prefix any `mp-units` URL (main branch, other branches, issues, PRs, ...) in your web browser with `gitpod.io/#` +(i.e. https://gitpod.io/#https://github.com/mpusz/units). + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/mpusz/units) + ## Download, Build, Install -Please refer to our official docs for [download, build, and install instructions](https://mpusz.github.io/units/usage.html). +Alternatively, please refer to our official docs for [download, build, and install instructions](https://mpusz.github.io/units/usage.html) if you want to setup a development environemnt on your local machine. ## Where to start? diff --git a/README.md b/README.md index f18c929d..b97e6299 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ be found in ISO C++ paper [P1935](https://wg21.link/p1935) and [CppCon 2020 talk](https://www.youtube.com/watch?v=7dExYGSOJzo). We are actively looking for parties interested in field trialing the library.** +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/mpusz/units) + ## Documentation