mirror of https://github.com/SixLabors/ImageSharp
Browse Source
Former-commit-id: 538935d6a6f3c35bfbacee5d5fde8084cf0a0219 Former-commit-id: 7cd14f791fd2d4ecd8a0b2ac63a1a15ace305e38 Former-commit-id: 16f2a2eb75e7f97596b3390bd50648ee63751249pull/17/head
James Jackson-South
10 years ago
1 changed files with 14 additions and 37 deletions
@ -1,49 +1,26 @@ |
|||
# ImageProcessor |
|||
|
|||
### Build Status |
|||
**This branch contains the highly experimental cross platform version of ImageProcessor**. |
|||
|
|||
|Branch | | |
|||
|:--------|:--------| |
|||
|**Debug**|[](https://ci.appveyor.com/project/JamesSouth/imageprocessor)| |
|||
|**Release**|[](https://ci.appveyor.com/project/JamesSouth/imageprocessor/branch/Master)| |
|||
|**Coverage Report**|[](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**|[](https://www.nuget.org/packages/ImageProcessor/)|[](https://www.nuget.org/packages/ImageProcessor/)| |
|||
|**ImageProcessor.Web**|[](https://www.nuget.org/packages/ImageProcessor.Web/)|[](https://www.nuget.org/packages/ImageProcessor.Web/)| |
|||
###Why am I writing this? |
|||
|
|||
[](https://huboard.com/JimBobSquarePants/ImageProcessor/) |
|||
[](http://sourcebrowser.io/Browse/JimBobSquarePants/ImageProcessor/) |
|||
[](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 <http://imageprocessor.org>. 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 <http://localhost:4000> 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. |
|||
|
|||
Loading…
Reference in new issue