Skip to content

Commit 4a9f05d

Browse files
committed
update readme for more public viewing and interaction
1 parent 3bd1326 commit 4a9f05d

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,19 @@
1-
This repo controls the _Learn `json-everything`_ website and all of its content.
1+
## Welcome
22

3-
- Main site (playground): https://json-everything.net
4-
- Learning sandbox: https://learn.json-everything.net
3+
This repository houses the source for `json-everything` learning site, https://learn.json-everything.net.
4+
5+
## Contributing
6+
7+
We're happy to accept and review proposals for lessons. In general, lessons will cover how to use the libraries.
8+
9+
Each lesson should focus on a single feature of the library. The coding exercise should be tailored so that completion requires the learner to use the feature.
10+
11+
There is a lesson editor WPF app that makes creating lessons quite simple. If you're just creating a lesson, running this app (`run edit`) is recommended.
12+
13+
The main project's [CODE OF CONDUCT](https://github.com/json-everything/json-everything/blob/master/CODE_OF_CONDUCT.md) also applies.
14+
15+
## Running locally
16+
17+
The site is a Blazor WASM app running .Net 8, and it's published via GitHub Pages.
18+
19+
You can run the `run.cmd` script to start up the site. If you add an `edit` parameter, it'll run the editor.

0 commit comments

Comments
 (0)