From 1e71c112a63c6adc1f496f744302232d15a46e66 Mon Sep 17 00:00:00 2001 From: Gregory Ashton <gregory.ashton@ligo.org> Date: Thu, 31 May 2018 10:57:36 +1000 Subject: [PATCH] Add link to documentation and help with submitting issues and MRs --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 4063c1546..703537234 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,14 @@ https://monash.docs.ligo.org/tupak/htmlcov/) Fulfilling all your gravitational wave dreams. +Documentation can be found +[here](https://monash.docs.ligo.org/tupak/index.html). This and the code in +general are a work in progress. We encourage you to submit issues via are +[issue tracker](https://git.ligo.org/Monash/tupak/issues) and contribute to the +development via a merge request (for help in creating a merge request, see +[this page](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html) or +contact us directly. + ## Example To get started with `tupak`, we have a few examples and tutorials: -- GitLab