From 146e97e6f55a991ba1b272533f5a671c47ba6cb2 Mon Sep 17 00:00:00 2001 From: Stephen Moon Date: Fri, 9 Sep 2016 22:51:10 +0100 Subject: [PATCH 1/2] Minor typos. --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fc4ff14d0..1ab39a67c 100644 --- a/README.md +++ b/README.md @@ -6,15 +6,15 @@ ## Pretzel -A simple, pluggable site generation tool for .NET developers and Windows users (with Mono support planned I think) +A simple, pluggable site generation tool for .NET developers and Windows users (with Mono support planned I think). -Pretzel follows the same conventions as [Jekyll](https://github.com/jekyll/jekyll) and should be compatible with basic Jekyll websites. If you are not familiar with Jekyll, have a read at [http://jekyllrb.com/docs/usage/](http://jekyllrb.com/docs/usage/) +Pretzel follows the same conventions as [Jekyll](https://github.com/jekyll/jekyll) and should be compatible with basic Jekyll websites. If you are not familiar with Jekyll, have a read at [http://jekyllrb.com/docs/usage/](http://jekyllrb.com/docs/usage/). ### Usage The principal commands are the following but more informations are available on the [wiki](https://github.com/Code52/pretzel/wiki) -**Create** is used to create the folder structure for a new site. +**Create** is used to create the folder structure for a new site: pretzel create @@ -36,7 +36,6 @@ To explicitly specify the input - we should support inferring the input based on pretzel bake --engine liquid - **Taste** is for testing a site locally - make a change, and pretzel should handle regenerating the page when a file changes. To test a site locally, run: @@ -49,12 +48,11 @@ To specify the port to serve the site from (default will be 4000), run: To stop the site, press q. -*More infos on the [wiki](https://github.com/Code52/pretzel/wiki)* +*More information on the [wiki](https://github.com/Code52/pretzel/wiki)*. ### Contributing All contributions are welcome, please read our [contributing guide](CONTRIBUTING.md). - ### Attribution “[Pretzel](https://thenounproject.com/noun/pretzel/#icon-No555)” symbol by Edward Boatman on [The Noun Project](https://thenounproject.com/), from The Noun Project collection. From a6ea15acf370f7beb154eed78eff1dd8f282c04e Mon Sep 17 00:00:00 2001 From: Stephen Moon Date: Fri, 9 Sep 2016 22:53:10 +0100 Subject: [PATCH 2/2] Minor typos. --- CONTRIBUTING.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 536e271bb..38ffb7a24 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -15,19 +15,19 @@ Once you're familiar with Git and GitHub, clone the repository and run the ```.\ * [JabbR Chatroom](http://jabbr.net/#/rooms/code52) * [GitHub Issues](https://github.com/Code52/pretzel/issues) -**The functionalities are based as much as possible on existing functionalities in jekyll** +**The functionality is based as much as possible on existing functionality in Jekyll** -Each new functionnality must have been discussed first before submitting it in a PR. +Each new feature must have been discussed first before submitting it in a PR. ## Coding conventions We are following as much as possible the [C# coding conventions](https://msdn.microsoft.com/en-us/library/ff926074.aspx). -We prefer spaces over tab for indentation. +We prefer spaces over tabs for indentation. We have an [editorconfig](http://EditorConfig.org) [file](./.editorconfig) if you use an editor or plugin respecting it. ## Testing -Tests are mandatory for new functionality, please add some in the tests suit. +Tests are mandatory for new functionality, please add some in the tests suite. You can see the result either: - in Visual Studio or other IDE supporting xUnit2 - by executing build.cmd