diff --git a/README.md b/README.md index 52be28c..7dc4e1d 100644 --- a/README.md +++ b/README.md @@ -97,17 +97,17 @@ Where the variables represent the following ideas: - `PROGRAMMING_LANGUAGE` - is the programming language used for the code snippets (e.g Rust). - `READING_LANGUAGE` - is the language that the idea is read / spoken (e.g English). -It is highly reccomended examples also offer a demo where reasonable. Demos should be placed: +It is highly recommended examples also offer a demo where reasonable. Demos should be placed: `examples/EXAMPLE_NAME/demo/PROGRAMMING_LANGUAGE` -Please place all relevant files there, and feel free to serve via an iframe, or link to the full source code. It is also reccomended you offer a `README.md` to explain the demo, or simply offer build instructions. +Please place all relevant files there, and feel free to serve via an iframe, or link to the full source code. It is also recommended you offer a `README.md` to explain the demo, or simply offer build instructions. Now that we understand how examples are made, let's see some general guidance for contributing examples: ### Creating a new Example -Awesome! Glad to see new examples and ideas! I'd reccomended opening an issue before contributing an entirely new example. This way we can discuss if the example idea is beneficial, and to bring awareness to other contributors that ma want to do any translations and things. +Awesome! Glad to see new examples and ideas! I'd recommended opening an issue before contributing an entirely new example. This way we can discuss if the example idea is beneficial, and to bring awareness to other contributors that ma want to do any translations and things. After the idea has been discussed, feel free to open a PR following the format explained above, and we can review and add it to the website! @@ -115,7 +115,7 @@ By default, all new examples will be last in the example list on the homepage. T ### Adding a new Programming Language to an Example -If you are adding a new programming language, feel free to simply open a new PR with the format explained above, and we can review and add it to the website! **NOTE:** It is highly reccomended you add a demo of your example, unless there is a good reason for not providing one. +If you are adding a new programming language, feel free to simply open a new PR with the format explained above, and we can review and add it to the website! **NOTE:** It is highly recommended you add a demo of your example, unless there is a good reason for not providing one. ### Adding a new Reading Language (Translation) to an Example @@ -123,7 +123,7 @@ If you are adding a new reading language, feel free to simply open a new PR with ## Improving the shell (the base website) -Improving the shell (E.g the language switcher or typos in the landing page and things), feel free to open a PR! For larger ideas or new sections of the site, it is reccomended to open an issue first for discussion. +Improving the shell (E.g the language switcher or typos in the landing page and things), feel free to open a PR! For larger ideas or new sections of the site, it is recommended to open an issue first for discussion. ## Any other contributions