Skip to content

Commit

Permalink
add minimal developer help in ReadME
Browse files Browse the repository at this point in the history
  • Loading branch information
HLWeil committed Dec 23, 2024
1 parent d344983 commit 89caeb6
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,19 @@ The official ARC (annotated research context) website!

[arc-rdm.org](https://www.arc-rdm.org)

## Development

### Requirements

- [Node](https://nodejs.org/en) needs to be installed on your machine.

### Local Build

You can build the website locally, to verify the changes you make.

In the command line, run:

1. `npm install` to install the dependencies
2. `npm run dev` to build the site in watch-mode

Then, in the browser, navigate to the localhost address stated in the CI, e.g. `http://localhost:4321/`.

0 comments on commit 89caeb6

Please sign in to comment.