From 4dc1f1f6eb21048ec6449473a7dc38a5a84c8a89 Mon Sep 17 00:00:00 2001 From: Sven Efftinge Date: Mon, 7 Jan 2019 12:52:02 +0000 Subject: [PATCH] Added contribute section and gitpod config --- .gitpod.yml | 7 +++++++ README.md | 16 ++++++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 .gitpod.yml diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 000000000..cda41045d --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,7 @@ +tasks: + - before: nvm install 10 && nvm use 10 + init: npm install + command: npm run start +ports: + - port: 8080 + onOpen: open-preview \ No newline at end of file diff --git a/README.md b/README.md index 1751bdecd..57f7a727d 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Trilium Notes [![Join the chat at https://gitter.im/trilium-notes/Lobby](https://badges.gitter.im/trilium-notes/Lobby.svg)](https://gitter.im/trilium-notes/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -Trilium Notes is a hierarchical note taking application with focus on building large personal knowledge bases. See [screenshots](https://github.com/zadam/trilium/wiki/Screenshot-tour) for quick overview: +Trilium Notes is a hierarchical note taking application with focus on building large personal knowledge bases. See [screenshots](https://github.com/zadam/trilium/wiki/Screenshot-tour) for quick overview: ![](https://raw.githubusercontent.com/wiki/zadam/trilium/images/screenshot.png) @@ -34,4 +34,16 @@ Trilium is provided as either desktop application (Linux, Windows, Mac) or web a [See wiki for complete list of documentation pages.](https://github.com/zadam/trilium/wiki/) -You can also read [Patterns of personal knowledge base](https://github.com/zadam/trilium/wiki/Patterns-of-personal-knowledge-base) to get some inspiration on how you might use Trilium. \ No newline at end of file +You can also read [Patterns of personal knowledge base](https://github.com/zadam/trilium/wiki/Patterns-of-personal-knowledge-base) to get some inspiration on how you might use Trilium. + +## Contribute + +Use a browser based dev environment + +[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/zadam/trilium) + +Or clone locally and run +``` +npm install +npm run start +``` \ No newline at end of file