Skip to content
This repository was archived by the owner on Jun 25, 2020. It is now read-only.

Minor typos #313

Merged
laedit merged 2 commits into from
Sep 10, 2016
Merged

Minor typos #313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
146e97e
Minor typos.
s-moon Sep 9, 2016
a6ea15a
Minor typos.
s-moon Sep 9, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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:
Expand All @@ -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.