ImageSharp.Drawing/README.md

106 строки
5.7 KiB
Markdown
Исходник Постоянная ссылка Обычный вид История

2017-10-09 16:11:58 +03:00
<h1 align="center">
2018-03-25 08:12:22 +03:00
2022-02-10 21:24:55 +03:00
<img src="https://raw.githubusercontent.com/SixLabors/Branding/main/icons/imagesharp.drawing/sixlabors.imagesharp.drawing.512.png" alt="SixLabors.ImageSharp.Drawing" width="256"/>
2018-03-25 08:12:22 +03:00
<br/>
2020-01-14 14:22:08 +03:00
SixLabors.ImageSharp.Drawing
2017-10-09 16:13:06 +03:00
</h1>
2017-10-09 16:11:58 +03:00
2018-03-25 08:12:22 +03:00
<div align="center">
[![Build Status](https://img.shields.io/github/actions/workflow/status/SixLabors/ImageSharp.Drawing/build-and-test.yml?branch=main)](https://github.com/SixLabors/ImageSharp.Drawing/actions)
2020-06-08 13:30:07 +03:00
[![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
2022-02-10 19:55:28 +03:00
[![Code coverage](https://codecov.io/gh/SixLabors/ImageSharp.Drawing/branch/main/graph/badge.svg)](https://codecov.io/gh/SixLabors/ImageSharp.Drawing)
2018-03-25 08:12:22 +03:00
[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=flat&logo=twitter)](https://twitter.com/intent/tweet?hashtags=imagesharp,dotnet,oss&text=ImageSharp.+A+new+cross-platform+2D+graphics+API+in+C%23&url=https%3a%2f%2fgithub.com%2fSixLabors%2fImageSharp&via=sixlabors)
</div>
2021-04-24 16:41:36 +03:00
### **ImageSharp.Drawing** provides extensions to ImageSharp containing powerful, cross-platform 2D polygon manipulation and drawing APIs.
2017-10-09 16:11:58 +03:00
2020-01-14 14:22:08 +03:00
Designed to democratize image processing, ImageSharp.Drawing brings you an incredibly powerful yet beautifully simple API.
2016-12-22 08:22:21 +03:00
2020-01-14 14:22:08 +03:00
Built against .NET Standard 1.3, ImageSharp.Drawing can be used in device, cloud, and embedded/IoT scenarios.
2020-06-08 13:30:07 +03:00
## License
- ImageSharp.Drawing is licensed under the [Apache License, Version 2.0](https://opensource.org/licenses/Apache-2.0)
2021-04-24 16:41:36 +03:00
- An alternative Commercial Support License can be purchased **for projects and applications requiring support**.
2020-06-08 13:30:07 +03:00
Please visit https://sixlabors.com/pricing for details.
2021-04-24 16:41:36 +03:00
## Support Six Labors
Support the efforts of the development of the Six Labors projects.
- [Purchase a Commercial Support License :heart:](https://sixlabors.com/pricing/)
- [Become a sponsor via GitHub Sponsors :heart:]( https://github.com/sponsors/SixLabors)
- [Become a sponsor via Open Collective :heart:](https://opencollective.com/sixlabors)
2020-06-08 13:30:07 +03:00
## Documentation
- [Detailed documentation](https://sixlabors.github.io/docs/) for the ImageSharp.Drawing API is available. This includes additional conceptual documentation to help you get started.
2022-02-10 21:24:55 +03:00
- Our [Samples Repository](https://github.com/SixLabors/Samples/tree/main/ImageSharp) is also available containing buildable code samples demonstrating common activities.
2020-06-08 13:30:07 +03:00
2020-06-08 20:50:02 +03:00
## Questions?
2020-06-21 19:02:24 +03:00
- Do you have questions? We are happy to help! Please [join our Discussions Forum](https://github.com/SixLabors/ImageSharp.Drawing/discussions/category_choices), or ask them on [stackoverflow](https://stackoverflow.com) using the `ImageSharp` tag. **Do not** open issues for questions!
2022-02-10 19:55:28 +03:00
- Please read our [Contribution Guide](https://github.com/SixLabors/ImageSharp.Drawing/blob/main/.github/CONTRIBUTING.md) before opening issues or pull requests!
2020-06-08 20:50:02 +03:00
## Code of Conduct
This project has adopted the code of conduct defined by the [Contributor Covenant](https://contributor-covenant.org/) to clarify expected behavior in our community.
For more information, see the [.NET Foundation Code of Conduct](https://dotnetfoundation.org/code-of-conduct).
## Installation
2020-06-08 13:30:07 +03:00
Install stable releases via Nuget; development releases are available via MyGet.
| Package Name | Release (NuGet) | Nightly (MyGet) |
|--------------------------------|-----------------|-----------------|
| `SixLabors.ImageSharp.Drawing` | [![NuGet](https://img.shields.io/nuget/v/SixLabors.ImageSharp.Drawing.svg)](https://www.nuget.org/packages/SixLabors.ImageSharp.Drawing/) | [![MyGet](https://img.shields.io/myget/sixlabors/v/SixLabors.ImageSharp.Drawing.svg)](https://www.myget.org/feed/sixlabors/package/nuget/SixLabors.ImageSharp.Drawing) |
2017-01-04 10:12:32 +03:00
2020-06-08 20:50:02 +03:00
## Manual build
2017-09-16 21:15:23 +03:00
2020-01-14 14:22:08 +03:00
If you prefer, you can compile ImageSharp.Drawing yourself (please do and help!)
2017-09-16 21:15:23 +03:00
2020-06-08 20:50:02 +03:00
- Using [Visual Studio 2019](https://visualstudio.microsoft.com/vs/)
- Make sure you have the latest version installed
2021-04-24 16:41:36 +03:00
- Make sure you have [the .NET 5 SDK](https://www.microsoft.com/net/core#windows) installed
Alternatively, you can work from command line and/or with a lightweight editor on **both Linux/Unix and Windows**:
2017-09-16 21:15:23 +03:00
- [Visual Studio Code](https://code.visualstudio.com/) with [C# Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp)
2018-10-16 02:06:41 +03:00
- [.NET Core](https://www.microsoft.com/net/core#linuxubuntu)
2017-09-16 21:15:23 +03:00
2020-06-08 20:50:02 +03:00
- [Visual Studio Code](https://code.visualstudio.com/) with [C# Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.csharp)
- [.NET Core](https://www.microsoft.com/net/core#linuxubuntu)
To clone ImageSharp.Drawing locally, click the "Clone in [YOUR_OS]" button above or run the following git commands:
2017-09-16 21:15:23 +03:00
```bash
2020-01-14 14:22:08 +03:00
git clone https://github.com/SixLabors/ImageSharp.Drawing
2017-09-16 21:15:23 +03:00
```
If working with Windows please ensure that you have enabled log file paths in git (run as Administrator).
```bash
git config --system core.longpaths true
```
### Submodules
2019-03-21 20:48:23 +03:00
This repository contains [git submodules](https://blog.github.com/2016-02-01-working-with-submodules/). To add the submodules to the project, navigate to the repository root and type:
``` bash
git submodule update --init --recursive
```
2020-06-08 20:50:02 +03:00
## How can you help?
2022-02-10 19:55:28 +03:00
Please... Spread the word, contribute algorithms, submit performance improvements, unit tests, no input is too little. Make sure to read our [Contribution Guide](https://github.com/SixLabors/ImageSharp.Drawing/blob/main/.github/CONTRIBUTING.md) before opening a PR.
2020-06-08 20:50:02 +03:00
## The ImageSharp Team
2020-01-14 14:22:08 +03:00
- [Scott Williams](https://github.com/tocsoft)
- [James Jackson-South](https://github.com/jimbobsquarepants)
- [Dirk Lemstra](https://github.com/dlemstra)
2016-12-28 05:32:05 +03:00
- [Anton Firsov](https://github.com/antonfirsov)
2022-02-10 19:55:28 +03:00
- [Brian Popow](https://github.com/brianpopow)