From d9ed1acac279ae95ea7c42365379a43b76e6199d Mon Sep 17 00:00:00 2001 From: Dan Cox Date: Thu, 15 Apr 2021 09:02:58 -0400 Subject: [PATCH 1/2] Cleaning up README; 2.1 version --- README.md | 14 +++++++------- pages/index.md | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 8bb9d21..6b116c9 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,16 @@ It can be found at `https://twinery.org/cookbook/`. ## Building the Cookbook using MkDocs -The *Cookbook* can be built using Python. Run `pip install -r requirements.txt` to install the requirements and then using `mkdocs build` to build or `mkdocs serve` to create a build and host a local server version. +The *Cookbook* can be built using Python. Run `pip install -r requirements.txt` to install the requirements. -**Note:** Depending on how Python is installed in Windows, users may need to use `pip install --user -r requirements.txt` to install and then use `python -m` before any MkDocs commands to build or serve. +* `mkdocs build` creates HTML and CSS files based on the markdown files. +* `mkdocs serve` builds and hosts a local server version. -## *Want to suggest a change or new example?* +**Note:** Depending on how Python is installed in Windows, users may need to use `pip install --user -r requirements.txt` to install and then use `python -m` before any MkDocs commands. -Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookbook/blob/master/CODE_OF_CONDUCT.md). Then, include as much as possible of the following in an [issue](https://github.com/iftechfoundation/twine-cookbook/issues): +## *Want to suggest a change or new example?* -* A short summary of the example(s) or suggestions(s) -* How (or if) you would like to be recognized for your contribution +Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookbook/blob/master/CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](https://github.com/videlais/twine-cookbook/blob/master/CONTRIBUTING.md). ## Contributors @@ -41,4 +41,4 @@ Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookb This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/). -## Version 2.0 (May 2020) +## Version 2.1 (April 2021) diff --git a/pages/index.md b/pages/index.md index 8bb9d21..6b116c9 100644 --- a/pages/index.md +++ b/pages/index.md @@ -10,16 +10,16 @@ It can be found at `https://twinery.org/cookbook/`. ## Building the Cookbook using MkDocs -The *Cookbook* can be built using Python. Run `pip install -r requirements.txt` to install the requirements and then using `mkdocs build` to build or `mkdocs serve` to create a build and host a local server version. +The *Cookbook* can be built using Python. Run `pip install -r requirements.txt` to install the requirements. -**Note:** Depending on how Python is installed in Windows, users may need to use `pip install --user -r requirements.txt` to install and then use `python -m` before any MkDocs commands to build or serve. +* `mkdocs build` creates HTML and CSS files based on the markdown files. +* `mkdocs serve` builds and hosts a local server version. -## *Want to suggest a change or new example?* +**Note:** Depending on how Python is installed in Windows, users may need to use `pip install --user -r requirements.txt` to install and then use `python -m` before any MkDocs commands. -Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookbook/blob/master/CODE_OF_CONDUCT.md). Then, include as much as possible of the following in an [issue](https://github.com/iftechfoundation/twine-cookbook/issues): +## *Want to suggest a change or new example?* -* A short summary of the example(s) or suggestions(s) -* How (or if) you would like to be recognized for your contribution +Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookbook/blob/master/CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](https://github.com/videlais/twine-cookbook/blob/master/CONTRIBUTING.md). ## Contributors @@ -41,4 +41,4 @@ Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookb This work is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/). -## Version 2.0 (May 2020) +## Version 2.1 (April 2021) From cdbc293745d07d3dd1e1bc60cb3a53b944bc475c Mon Sep 17 00:00:00 2001 From: Dan Cox Date: Thu, 15 Apr 2021 09:30:15 -0400 Subject: [PATCH 2/2] Updated README links --- README.md | 2 +- pages/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6b116c9..48bc766 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ The *Cookbook* can be built using Python. Run `pip install -r requirements.txt` ## *Want to suggest a change or new example?* -Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookbook/blob/master/CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](https://github.com/videlais/twine-cookbook/blob/master/CONTRIBUTING.md). +Start with the [Code of Conduct](./CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](./CONTRIBUTING.md). ## Contributors diff --git a/pages/index.md b/pages/index.md index 6b116c9..48bc766 100644 --- a/pages/index.md +++ b/pages/index.md @@ -19,7 +19,7 @@ The *Cookbook* can be built using Python. Run `pip install -r requirements.txt` ## *Want to suggest a change or new example?* -Start with the [Code of Conduct](https://github.com/iftechfoundation/twine-cookbook/blob/master/CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](https://github.com/videlais/twine-cookbook/blob/master/CONTRIBUTING.md). +Start with the [Code of Conduct](./CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](./CONTRIBUTING.md). ## Contributors