Skip to content

Commit 4db4297

Browse files
committed
Add README.md
1 parent 9d03c9e commit 4db4297

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
The Fram Language
2+
=================
3+
4+
This repository contains the source files for the Fram language documentation,
5+
which is currently hosted at [fram-lang.org](https://fram-lang.org/).
6+
7+
Contributing
8+
------------
9+
10+
The documentation is written in markdown and built using
11+
[mdBook](https://rust-lang.github.io/mdBook/).
12+
The [mdBook-KaTeX](https://github.com/lzanini/mdbook-katex) preprocessor is
13+
required to render math, but local builds should fail gracefully when it's not
14+
present.
15+
16+
In order to build the site locally, run `mdbook build` in the root of the
17+
project's directory. You can also launch a local HTTP server and rebuild
18+
automatically on changes using the following command.
19+
```
20+
mdbook serve
21+
```
22+
23+
Deployment
24+
----------
25+
26+
The website is hosted using GitHub Pages. Deployment is performed automatically
27+
from the `master` branch of this repository; for details see [the workflow
28+
file](.github/workflows/deploy.yml).

0 commit comments

Comments
 (0)