Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 2.61 KB

README.md

File metadata and controls

36 lines (24 loc) · 2.61 KB

ImageProcessor

![Gitter](https://badges.gitter.im/Join Chat.svg)

Build status

Imageprocessor is a lightweight library written in C# that allows you to manipulate images on-the-fly using .NET 4.5+

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/

##Contributing to ImageProcessor Contribution is most welcome! I mean, that's what this is all about isn't it?

Things I would ❤️ 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! 🚔

##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 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 and publicly hosted on GitHub Pages at http://imageprocessor.org. The docs may also be run locally.

Running documentation locally

  1. If necessary, install Jekyll (requires v2.2.x).
  1. From the root /ImageProcessor directory, run jekyll serve in the command line.
  2. Open http://localhost:4000 in your browser to navigate to your site. Learn more about using Jekyll by reading its documentation.