From d263296c8a16bdecf97b37da7694dc209ea78af9 Mon Sep 17 00:00:00 2001 From: Sam Fearn Date: Fri, 8 Jun 2018 17:20:30 +0100 Subject: [PATCH] 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. --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46457b9..c865e8d 100644 --- a/README.md +++ b/README.md @@ -39,13 +39,17 @@ By default, the script uses the `master` branch for the source code and deploys The optional flag `--user` tells it to deploy to `master` and use `source` for the source code instead. Using `master` for deployment is a convention for [user and organization pages](https://help.github.com/articles/user-organization-and-project-pages/). -**Note:** when deploying your user or organization page, make the `_config.yml` has `url` and `baseurl` fields as follows. +**Note:** when deploying your user or organization page, make sure the `_config.yml` has `url` and `baseurl` fields as follows. ``` url: # should be empty baseurl: # should be empty ``` +### Usage ### + +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. + ## Features #### Ergonomic Publications @@ -100,4 +104,4 @@ Style improvements and bug fixes are especially welcome. ## License -MIT +The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT). \ No newline at end of file