Skip to content

Commit d263296

Browse files
committed
added a usage section to the readme describing that an index page is not neccessary, and will overwrite the about page if it exists. Also added a link to the MIT license following the default jekyll theme readme.
1 parent d05f8a3 commit d263296

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,17 @@ By default, the script uses the `master` branch for the source code and deploys
3939
The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead.
4040
Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/).
4141

42-
**Note:** when deploying your user or organization page, make the `_config.yml` has `url` and `baseurl` fields as follows.
42+
**Note:** when deploying your user or organization page, make sure the `_config.yml` has `url` and `baseurl` fields as follows.
4343

4444
```
4545
url: # should be empty
4646
baseurl: # should be empty
4747
```
4848

49+
### Usage ###
50+
51+
Note that `_pages/about.md` is built to index.html in the published site. There is therefore no need to have a separate index page for the project. If an index page does exist in the root directory then this will prevent `_pages/about.md` from being added to the built site.
52+
4953
## Features
5054

5155
#### Ergonomic Publications
@@ -100,4 +104,4 @@ Style improvements and bug fixes are especially welcome.
100104

101105
## License
102106

103-
MIT
107+
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

0 commit comments

Comments
 (0)