Skip to content

Commit 4992c12

Browse files
fix typos in README
1 parent dc06b50 commit 4992c12

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Fast ML Lab Website Insructions
2-
This website is built on Github Pages using Jekyll, and thus, editing raw HTML should be unneccessary for most content updates.
1+
# Fast ML Lab Website Instructions
2+
This website is built on GitHub Pages using Jekyll, and thus, editing raw HTML should be unnecessary for most content updates.
33

44
## Add a News Item
55

@@ -14,7 +14,7 @@ description: 'hls4ml: an open-source code framework for translating machine lear
1414
image: /images/hls4ml.png
1515
---
1616
```
17-
Note that file paths for images should include a leading `/` to indicate an absolute path from the root of the site. Putting quotes around the title/description (single or double) is reccomended to avoid issues with yaml parsing. You can also add markdown content following this header and it will render as a complete web page, but as of yet there is no link to this post displayed on the front page, only content from the header. This may change in the future.
17+
Note that file paths for images should include a leading `/` to indicate an absolute path from the root of the site. Putting quotes around the title/description (single or double) is recommended to avoid issues with yaml parsing. You can also add markdown content following this header and it will render as a complete web page, but as of yet there is no link to this post displayed on the front page, only content from the header. This may change in the future.
1818

1919

2020
## Add a Person
@@ -33,7 +33,7 @@ Note that the Jekyll site is set up to generate and alphabetize the institution
3333
## Add a Paper
3434
Add papers to the yaml list in `_data/papers.yml`
3535

36-
Note that this will render markdown syntax. Putting quotes around the title (single or double) is reccomended to avoid issues with yaml parsing.
36+
Note that this will render markdown syntax. Putting quotes around the title (single or double) is recommended to avoid issues with yaml parsing.
3737

3838
**Example:**
3939
```yaml
@@ -43,7 +43,7 @@ Note that this will render markdown syntax. Putting quotes around the title (sin
4343
## Add a Talk
4444
Add talks to the yaml list in `_data/talks.yml`
4545

46-
Note that this will render markdown syntax. Putting quotes around the title (single or double) is reccomended to avoid issues with yaml parsing.
46+
Note that this will render markdown syntax. Putting quotes around the title (single or double) is recommended to avoid issues with yaml parsing.
4747

4848
**Example:**
4949
```yaml
@@ -64,4 +64,4 @@ Note that this will **not** render markdown syntax. Entries for both `name` and
6464
## Test the Site Locally
6565
To test the site locally, install Jekyll along with the Jekyll github-pages extension (doing so via conda is recommended) and run the following command: `jekyll serve`
6666

67-
This will start a local development web server to preview the site. Note that updating the config files may require restarting this server to take effect.
67+
This will start a local development web server to preview the site. Note that updating the config files may require restarting this server to take effect.

0 commit comments

Comments
 (0)