Skip to content

Commit eda64ec

Browse files
committed
Start the README
1 parent 5fb739b commit eda64ec

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# The Automerge Website
2+
3+
This repository holds the [Automerge website](https://automerge.org), including all the docs, blog posts, and other site **content**, the **templates** that give pages their structure and styling, and a custom build **system** that weaves it all together.
4+
5+
<br><br>
6+
7+
# Getting Started
8+
9+
First:
10+
* Clone the repo and run `npm install` (or `yarn`, or `pnpm`… whatever you use, it'll probably work).
11+
12+
Henceforth:
13+
* Run `site` to build the website and spin up a live-reloading dev server.
14+
* Run `site help` to see other available commands.
15+
16+
> If `site` doesn't work, use `./site` instead (or add `.` to your $PATH)
17+

0 commit comments

Comments
 (0)