Skip to content

Commit

Permalink
Merge pull request #133 from videlais/master
Browse files Browse the repository at this point in the history
Cleaning up README; 2.1 version
  • Loading branch information
Dan Cox authored Apr 15, 2021
2 parents 8da32c0 + cdbc293 commit 618512b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](./CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](./CONTRIBUTING.md).

## Contributors

Expand All @@ -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)
14 changes: 7 additions & 7 deletions pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](./CODE_OF_CONDUCT.md) and then review the steps in the [Contributing guide](./CONTRIBUTING.md).

## Contributors

Expand All @@ -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)

0 comments on commit 618512b

Please sign in to comment.