Skip to content

Commit 66cd2f5

Browse files
committed
A few little Readme fixes
1 parent 5ccdf5a commit 66cd2f5

File tree

1 file changed

+5
-8
lines changed

1 file changed

+5
-8
lines changed

README.md

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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.
44

5+
We welcome all contributions. If you see any mistakes or glitches on the website, or have any trouble building the site locally, please [file an issue](https://github.com/automerge/website/issues) or [open a pull request](https://github.com/automerge/website/pulls). Thank you.
6+
57
<br><br>
68

79
# Getting Started
@@ -15,12 +17,6 @@ Henceforth:
1517

1618
> If `site` doesn't work, use `./site` instead (or add `.` to your $PATH)
1719
18-
<br>
19-
20-
### Contributions & Issues
21-
22-
If you see any issues with the website, or have any trouble running the build system yourself, please [file an issue](https://github.com/automerge/website/issues).
23-
2420
<br><br>
2521

2622
# Documentation
@@ -45,17 +41,18 @@ If you see any issues with the website, or have any trouble running the build sy
4541
Here's the folder structure:
4642

4743
* `content` — html and markdown files for every page, plus a few lightweight assets; see [pages](#pages)
48-
* `demo` — source files for the interactive demo on the home page.
44+
* `demo` — source files for the interactive demo on the home page
4945
* `fonts` — uncompressed source files for fonts used on the site; see [fonts](#fonts)
5046
* `public` — automatically generated when building the site
5147
* `system` — the build system source code; see [system](#system)
5248
* `template` — html files that define different types of page on the site; see [templates](#templates)
49+
* `Redirects.txt` — Cool URIs don't change; see [redirects](#redirects)
5350

5451
This site is powered by our own custom build system, which we can adapt and extend as our needs change.
5552

5653
The build system takes HTML and Markdown files in the `content` folder, parses and transforms them with rules defined in `system`, combines the result with various templates in `template`, and finally saves the fully-assembled page to `public`.
5754

58-
In short, the `content` folder should feel like an FTP server. You put stuff in there, and it shows up on the website. The file path becomes the URL. There's more, of course — macros and templates and other behaviour that we'll get to in a second. But all that fanciness is *opt-in*. If you stick to plain HTML and simple assets, `/content` acts just like FTP.
55+
In short, the `content` folder should feel like an FTP server. You put stuff in there, and it shows up on the website. The file path becomes the URL. There's more, of course — macros and templates and other behaviour that we'll get to in a second. But all that fanciness is *opt-in*. If you stick to plain HTML and simple assets, `/content` feels just like FTP.
5956

6057
<br><br>
6158

0 commit comments

Comments
 (0)