Skip to content

Commit 2998cf3

Browse files
authored
Revise README for clarity and contribution guidelines
Updated project description and added information about documentation contributions.
1 parent 938ed95 commit 2998cf3

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
11
## Simplicity Docs
22

3-
Simplicity is a minimal, deterministic, functional language built for Bitcoin’s trust model. It offers elegance over complexity, enabling powerful smart contracts without relying on a growing list of ad hoc opcodes.
3+
This is the static site generator for https://docs.simplicty-lang.org. We aim to make usable, up-to-date documenation and welcome suggestions and updates via a pull request.
44

5-
The site is built on [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
6-
7-
Building
5+
The site is built on [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) which includes some [nice formatting options](https://squidfunk.github.io/mkdocs-material/reference/).
86

7+
Realtime preview of documentation changes:
98
```bash
109
# Install dependencies
1110
pip install -r requirements.txt

0 commit comments

Comments
 (0)