From c4605a84e629ecdd4ce9a0788b074b08ba874562 Mon Sep 17 00:00:00 2001 From: Robert Mulder Date: Sun, 25 May 2014 16:35:51 +0200 Subject: [PATCH 1/3] New url for full documentation It seems like the documentation url is outdated. Former-commit-id: f1a2a269d027bba05c18146ff9cac701c058bf21 --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a682ace934..8e933ae448 100644 --- a/README.md +++ b/README.md @@ -5,4 +5,4 @@ Imageprocessor is a lightweight library written in C# that allows you to manipul It's fast, extensible, easy to use, comes bundled with some great features and is fully open source. -For full documentation please see [http://jimbobsquarepants.github.io/ImageProcessor/](http://jimbobsquarepants.github.io/ImageProcessor/) +For full documentation please see [http://imageprocessor.org/](http://imageprocessor.org/) From 9c4ea231d11b1b5619951183af50cfd70c385763 Mon Sep 17 00:00:00 2001 From: James South Date: Tue, 27 May 2014 17:28:44 +0100 Subject: [PATCH 2/3] Adding more documentation info Former-commit-id: 13b27d119f6f1695e89485eb9410c71671db8ec7 --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 8e933ae448..bd07b0401b 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,29 @@ Imageprocessor is a lightweight library written in C# that allows you to manipul It's fast, extensible, easy to use, comes bundled with some great features and is fully open source. For full documentation please see [http://imageprocessor.org/](http://imageprocessor.org/) + +##Contributing to ImageProcessor +Contribution is most welcome! I mean, that's what this is all about isn't it? + +Things I would :heart: people to help me out with: + + - Unit tests. I need to get some going for all the regular expressions within the ImageProcessor core plus anywhere else we can think of. If that's your bag please contribute. + - Documentation. Nobody likes doing docs, I've written a lot but my prose is clumsy and verbose. If you think you can make things clearer or you spot any mistakes please submit a pull request (Guide to how the docs work below). + - Async. I'd love someone with real async chops to have a look at the ImageProcessor.Web. It works and it works damn well but I'm no expert on threading so I'm sure someone can improve on it. + +**Just remember to StyleCop all things! :oncoming_police_car:** + +##RoadMap +I want the next version of ImageProcessor to run on all devices. Sadly it looks like using `System.Drawing` will not allow me to do that so I need to have a look at using the classes within [System.Windows.Media.Imaging](http://msdn.microsoft.com/en-us/library/System.Windows.Media.Imaging(v=vs.110).aspx) This is a **LOT** of work so any help that could be offered would be greatly appreciated. + +##Documentation + +ImageProcessor's documentation, included in this repo in the gh_pages directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at . The docs may also be run locally. + +### Running documentation locally +1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.5.x). + - **Windows users:** Read [this unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems. +2. From the root `/ImageProcessor` directory, run `jekyll serve` in the command line. +3. Open in your browser to navigate to your site. +Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/). + From cce27cfc2724488c1ccd5ed35dd72a083ea2210b Mon Sep 17 00:00:00 2001 From: James South Date: Tue, 27 May 2014 17:31:42 +0100 Subject: [PATCH 3/3] Missing 0 Former-commit-id: 418bc8216fdda5b593eb0c3b1e97c3ee8ab610ee --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bd07b0401b..87a5574f70 100644 --- a/README.md +++ b/README.md @@ -29,6 +29,6 @@ ImageProcessor's documentation, included in this repo in the gh_pages directory, 1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.5.x). - **Windows users:** Read [this unofficial guide](https://github.com/juthilo/run-jekyll-on-windows/) to get Jekyll up and running without problems. 2. From the root `/ImageProcessor` directory, run `jekyll serve` in the command line. -3. Open in your browser to navigate to your site. +3. Open in your browser to navigate to your site. Learn more about using Jekyll by reading its [documentation](http://jekyllrb.com/docs/home/).