diff --git a/README.md b/README.md index af8a7ad..4460cee 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ # scverse.org -This is a website for [scverse.org](https://scverse.org). This version uses [Hugo](https://gohugo.io/) to build it. +This is a website for [scverse.org](https://scverse.org) based on [Hugo](https://gohugo.io/). ## Repository structure ### Content -Most of the times, only the content has to be modified. Content is stored as [TOML](https://toml.io/en/) in `.md` files in [`/content`](/content). E.g. to modify the contents of the tutorials page, one has to look inside [`/content/learn/_index.md`](/content/learn/_index.md). +Most of the times, only the content has to be modified. +Content is stored as [TOML](https://toml.io/en/) in `.md` files in [`/content`](/content). +To modify the contents of the tutorials page, for example, one has to look inside [`/content/learn/_index.md`](/content/learn/_index.md). ### Styles @@ -14,7 +16,8 @@ For style sheets, [SCSS](https://sass-lang.com/) is used. Modify [`/assets/main. ### Layout -Modifying layout is only required when pages have to be restuctured or new pages are to be added. Look inside [`/layout`](/layout) for that. [Hugo Templating](https://gohugo.io/templates/introduction/) is used to work with content from [`/content`](/content). +Modifying layout is only required when pages have to be restuctured or new pages are to be added. +Look inside [`/layout`](/layout) for that. [Hugo Templating](https://gohugo.io/templates/introduction/) is used to work with content from [`/content`](/content). ## Running locally