From 109a60b0bb7aee9ff581bdeea5054b2f049514e6 Mon Sep 17 00:00:00 2001 From: James Jackson-South Date: Thu, 8 Oct 2015 00:29:24 +1100 Subject: [PATCH] Update README.md Former-commit-id: 538935d6a6f3c35bfbacee5d5fde8084cf0a0219 Former-commit-id: 7cd14f791fd2d4ecd8a0b2ac63a1a15ace305e38 Former-commit-id: 16f2a2eb75e7f97596b3390bd50648ee63751249 --- README.md | 51 ++++++++++++++------------------------------------- 1 file changed, 14 insertions(+), 37 deletions(-) diff --git a/README.md b/README.md index 5ed8112fc..5394c522e 100644 --- a/README.md +++ b/README.md @@ -1,49 +1,26 @@ # ImageProcessor -### Build Status +**This branch contains the highly experimental cross platform version of ImageProcessor**. -|Branch | | -|:--------|:--------| -|**Debug**|[![Build status](https://ci.appveyor.com/api/projects/status/8ypr7527dnao04yr?svg=true)](https://ci.appveyor.com/project/JamesSouth/imageprocessor)| -|**Release**|[![Build status](https://ci.appveyor.com/api/projects/status/8ypr7527dnao04yr/branch/Master?svg=true)](https://ci.appveyor.com/project/JamesSouth/imageprocessor/branch/Master)| -|**Coverage Report**|[![Coverage Status](https://coveralls.io/repos/JimBobSquarePants/ImageProcessor/badge.svg)](https://coveralls.io/r/JimBobSquarePants/ImageProcessor?branch=V2)| +This is a complete rewrite from the ground up to allow the processing of images without the use of `System.Drawing` using a portable class library (PCL). -### Latest Releases -|Library |Version |Downloads | -|:-----------------|:-----------------|:-----------------| -|**ImageProcessor**|[![Nuget count](http://img.shields.io/nuget/v/ImageProcessor.svg)](https://www.nuget.org/packages/ImageProcessor/)|[![Nuget downloads](http://img.shields.io/nuget/dt/ImageProcessor.svg)](https://www.nuget.org/packages/ImageProcessor/)| -|**ImageProcessor.Web**|[![Nuget count](http://img.shields.io/nuget/v/ImageProcessor.Web.svg)](https://www.nuget.org/packages/ImageProcessor.Web/)|[![Nuget downloads](http://img.shields.io/nuget/dt/ImageProcessor.Web.svg)](https://www.nuget.org/packages/ImageProcessor.Web/)| +###Why am I writing this? -[![Issues open](http://img.shields.io/github/issues-raw/JimBobSquarePants/imageprocessor.svg)](https://huboard.com/JimBobSquarePants/ImageProcessor/) -[![Source Browser](https://img.shields.io/badge/Browse-Source-green.svg)](http://sourcebrowser.io/Browse/JimBobSquarePants/ImageProcessor/) -[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/JimBobSquarePants/ImageProcessor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +With NETCore there is currently no version of `System.Drawing` to allow continued progress of the existing ImageProcessor library. Progress developing a crossplatform update are restricted to the [CoreFXLab repo](https://github.com/dotnet/corefxlab/tree/master/src/System.Drawing.Graphics) where progress seems to be very slow. -Imageprocessor is a lightweight, extensible library written in C# that allows you to manipulate images on-the-fly using .NET 4.5+ +###Am I mad? -It's fast, extensible, easy to use, comes bundled with some great features and is fully open source. +Honestly... I don't know. I could be writing code that may be suddenly obsolete. There has been little [feedback](https://github.com/dotnet/corefxlab/issues/86#issuecomment-139930600) on questions I've asked but it's a nice learning process if anything. -For full documentation please see [http://imageprocessor.org/](http://imageprocessor.org/) +###What works so far? -## Contributing to ImageProcessor -Contribution is most welcome! I mean, that's what this is all about isn't it? +- Encoding/decoding of jpeg, bmp, png, and gif formats (Needs expansion for indexed pngs, more bmp formats) +- Basic color structs (Needs support for HDR colors etc). +- Basic shape primitives (Unfinished and could possible be updated by using Vector2, Vector3 etc) +- Bicubic resampling. (Needs more algorithms & performance tweaks) -Things I would :heart: people to help me out with: +###How can you help? - - 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). +Spread the word, contribute algorithms, performance improvements, unit tests. Help me setup the solution properly for NETCore etc (I dunno if I have my setup correct) -**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 an alternative. 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 branch, 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 v2.2.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/). +There's a lot of people out there who could write this stuff a lot better and faster than I and would love to get a little more sleep once in a while.