Skip to content

Commit f3fbf95

Browse files
committed
minor improvements
1 parent 88475fc commit f3fbf95

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

CONTRIBUTING.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
## Code of Conduct
33

4-
We are committed to providing a friendly, safe and welcoming environment for all. Make sure to take a look at the Code of Conduct!
4+
We are committed to providing a friendly, safe and welcoming environment for all. Make sure to take a look at the [Code of Conduct](https://github.com/roc-lang/roc/blob/main/CODE_OF_CONDUCT.md).
55

66
## How to contribute
77

@@ -24,14 +24,14 @@ If you are looking for a good place to start, check the [good first issues](http
2424

2525
## To view the examples site locally
2626

27-
Clone the roc repo if you don't have it already:
27+
Clone the Roc repo if you don't have it already:
2828
```
2929
git clone https://github.com/roc-lang/roc.git
3030
```
3131

32-
Update the path in ./main.roc:
32+
Update the path in the file `./main.roc` (of the example repo):
3333
```
34-
packages { pf: "/PATH_TO_ROC_REPO/examples/static-site-gen/platform/main.roc" }
34+
packages { pf: "/PATH_TO_ROC_REPO/examples/static-site-gen/platform/main.roc" }
3535
```
3636
Generate the html files:
3737
```
@@ -43,7 +43,7 @@ Copy the static assets from `./www` to `./build`:
4343
cp ./wwww/* ./build
4444
```
4545

46-
If you're using the nix flake simple-http-server will already be installed. Without nix you can install it with `cargo install simple-http-server`.
46+
If you're using the nix flake, simple-http-server will already be installed. Without nix you can do `cargo install simple-http-server`.
4747

4848
View the website:
4949
```

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Website coming soon!
77
## Running an example
88

99
1. [Install Roc](https://github.com/roc-lang/roc/tree/main/getting_started#installation)
10-
2. For json example: `roc run examples/Json/main.roc`
10+
2. For the json example: `roc run examples/Json/main.roc`
1111

1212
## Ideas and Improvements
1313

1414
If you have any ideas or improvements, talk to us on our [group chat](https://roc.zulipchat.com/), we're friendly!
1515

1616
## Contributing
1717

18-
Contributions are welcome :heart:
19-
Check out [CONTRIBUTING.md](CONTRIBUTING.md)
18+
Contributions are welcome :heart:
19+
Check out [CONTRIBUTING.md](contributing.md)

0 commit comments

Comments
 (0)