Skip to content

Commit

Permalink
Merge pull request #2 from acep-uaf/update-readme
Browse files Browse the repository at this point in the history
debug readme
  • Loading branch information
ianalexmac authored May 20, 2024
2 parents 6a89ff1 + e9e7b97 commit 972a948
Showing 1 changed file with 5 additions and 20 deletions.
25 changes: 5 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand All @@ -18,27 +16,14 @@ To embed the map in your website, use the following HTML code:
allowfullscreen>
</iframe>
```
Which will generate a map like the one below:

<iframe
width="600"
height="450"
frameborder="0"
style="border:0"
src="https://acep-uaf.github.io/sw-ARCTIC-locations/"
allowfullscreen>
</iframe>


<p data-source-line="14" class="empty-line final-line end-of-document" style="margin:0;"></p>


### 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
Expand All @@ -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.

0 comments on commit 972a948

Please sign in to comment.