From e9e7b97359029d3929335f5c60a4e0cd2beb2a2d Mon Sep 17 00:00:00 2001 From: ianalexmac Date: Mon, 20 May 2024 15:52:09 -0800 Subject: [PATCH] debug readme --- README.md | 25 +++++-------------------- 1 file changed, 5 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 3b21c65..b5ed5fd 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ ## Welcome This repository contains the code and data necessary to build an interactive web map of ARCTIC program locations. -## Getting Started - -Embed or Link to the Map +## Embed or Link to the Map To embed the map in your website, use the following HTML code: ``` @@ -18,27 +16,14 @@ To embed the map in your website, use the following HTML code: allowfullscreen> ``` -Which will generate a map like the one below: - - - - -

-### Update, Debug, or Develop +## Update, Debug, or Develop If you would like to update ARCTIC locations, debug problems with the map, or develop new features, start by cloning the repository to your local machine. The following steps assume you have `R`, `renv` (for managing R dependencies), `node.js`, and `npm` installed: -#### Install R Dependencies +## Install R Dependencies Once the repository has been cloned to your computer, install the necessary R dependencies 1. In a terminal window, navigate to the root directory of the repo 2. Start R by typing `R` and pressing Enter @@ -55,8 +40,8 @@ This will install the R packages specified in the `renv.lock` file. 4. Quit R by typing `q()` and pressing Enter -#### Install Javascript Dependencies +## Install Javascript Dependencies To install Javascript dependencies, navigate to the repo and run `npm install`. -### Adding Changes +## Adding Changes Changes made to update, debug, or develop are best done in a new branch such as `feature/your_cool_widget` or `bugfix/your_solution`. This new local branch can be pushed to a new branch on the remote, then a pull request made to merge the changes into `main`. Please note that direct commits to main are blocked so as not to break the public map. Pull requests will need approval before merging. All merges to `main` will rebuild the map. \ No newline at end of file