Skip to content
This repository was archived by the owner on Dec 27, 2023. It is now read-only.

Commit f986e87

Browse files
committed
Update README.md
Important structure changes in the README to make easier using the project and contributing.
1 parent e97b027 commit f986e87

File tree

1 file changed

+13
-25
lines changed

1 file changed

+13
-25
lines changed

README.md

Lines changed: 13 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,31 @@
1-
ColorSharp
1+
ColorSharp [![Build Status](https://travis-ci.org/Litipk/ColorSharp.svg?branch=master)](https://travis-ci.org/Litipk/ColorSharp)
22
==========
33

44
A .NET/Mono library to handle color spaces and light spectrums.
55

6-
[![Build Status](https://travis-ci.org/Litipk/ColorSharp.svg?branch=master)](https://travis-ci.org/Litipk/ColorSharp)
7-
86
## Getting Started
97

108
ColorSharp is available as a [nuget package](https://www.nuget.org/packages/ColorSharp/) so you can install by searching for "ColorSharp" in the "Manage Nuget Packages" menu, or run the following command in the integrated Monodevelo's Package Manager Console:
119

1210
`PM> Install-Package ColorSharp`
1311

14-
## Project Links
15-
16-
* [Documentation](https://github.com/Litipk/ColorSharp/wiki)
17-
* [TODO list](https://github.com/Litipk/ColorSharp/blob/master/TODO.md)
18-
* [Changelog](https://github.com/Litipk/ColorSharp/blob/master/CHANGELOG.md)
19-
* [Blog](https://colorsharp.wordpress.com/)
20-
* [OpenHUB Profile](https://www.openhub.net/p/ColorSharp)
21-
* [Travis CI Builds](https://travis-ci.org/Litipk/ColorSharp)
12+
## Learn more
2213

23-
## Inspiration
14+
* [Project Documentation](https://github.com/Litipk/ColorSharp/wiki) : Here you can find how to use ColorSharp in your applications.
15+
* [External References](https://github.com/Litipk/ColorSharp/blob/master/REFERENCES.md) : Here you can learn about the science behind ColorSharp and discover other projects that have inspired us.
16+
* [Blog](https://colorsharp.wordpress.com/) : News, technical articles, opinion...
2417

25-
This library is inspired by the following projects and information sources.
18+
## Project Status
2619

27-
### Code Libraries
28-
29-
* .NET/Mono:
30-
* [THEjoezack/ColorMine](https://github.com/THEjoezack/ColorMine/)
31-
* [tompazourek/Colourful](https://github.com/tompazourek/Colourful)
32-
* Python:
33-
* [Colour Science for Python](http://colour-science.org/index.php): This is an incredible project that has many repositories in Github, not only with Python code, but also with Matlab source code and other resources.
34-
* [fish2000/ColorPy](https://github.com/fish2000/ColorPy)
20+
* [Changelog](https://github.com/Litipk/ColorSharp/blob/master/CHANGELOG.md)
21+
* [Travis CI Builds](https://travis-ci.org/Litipk/ColorSharp)
22+
* [OpenHUB Profile](https://www.openhub.net/p/ColorSharp)
3523

36-
### Books
24+
## How to contribute
3725

38-
* *1998* - *Color Space Conversions* - Adrian Ford, Alan Roberts .
39-
* *2005* - *Colorimetry: Fundamentals and Applications* - Noboru Ohta, Alan R. Robertson .
40-
* *2007* - *Colorimetry: Understanding the CIE system* - János Schanda .
26+
* First of all, you can take a look on the [TODO list](https://github.com/Litipk/ColorSharp/blob/master/TODO.md) and decide if there is something that you want to do :) . If you think there are missing improvements in this file, then you are invited to modify the TODO list.
27+
* You can also send us bug reports through the [tracker](https://github.com/Litipk/ColorSharp/issues), or look for bugs to solve.
28+
* If you are really interested on helping to improve ColorSharp, we recommend to read the [contributing guidelines](https://github.com/Litipk/ColorSharp/blob/master/CONTRIBUTING.md).
4129

4230
## License
4331

0 commit comments

Comments
 (0)