From 31ee61a34f07dd7e67360b874d58c44547f8fd21 Mon Sep 17 00:00:00 2001 From: "Karl N. Kappler" Date: Fri, 22 Nov 2024 15:27:15 -0800 Subject: [PATCH] add notes for getting started a a developer --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 78f1e49..2d5cbb4 100644 --- a/README.md +++ b/README.md @@ -53,7 +53,22 @@ General workflow for dealing with MT data. Time series data can be stored and a ``` - +## Development Notes +To contribute or modify this package you can clone it from github. +To get started using MyST follow the official documentation: https://mystmd.org/guide/quickstart. + +In summary: +> git clone git@github.com:MTgeophysics/MTgeophysics.github.io.git +> +> cd MTgeophysics.github.io +> +> conda install mamba +> +> mamba install -c conda-forge mystmd +> +> myst + +This should yield a link in a terminal that takes you to a locally hosted version of the book. [2i2c]: https://2i2c.org/