A project to extends Pharo colors's classes with the Material Design recommandations
# MaterialColors
A project to extends Pharo colors's classes with the [Material Design](https://en.wikipedia.org/wiki/Material_Design) recommandations.
- [Documentation](#documentation)
* [Version management](#version-management)
* [Install MaterialColors](#install-materialcolors)
* [Resources](#resources)
* [Smalltalk versions compatibility](#smalltalk-versions-compatibility)
* [Contact](#contact)
# Documentation
## Version management
This project use semantic versionning to define the releases. This mean that each stable release of the project will get associate a version number of the form `vX.Y.Z`.
- **X** define the major version number
- **Y** define the minor version number
- **Z** define the patch version number
When a release contains only bug fixes, the patch number increase. When the release contains new features backward compatibles, the minor version increase. When the release contains breaking changes, the major version increase.
Thus, it should be safe to depend on a fixed major version and moving minor version of this project.
## Install MaterialColors
To install MaterialColors on your Pharo image you can just execute the following script:
```Smalltalk
Metacello new
githubUser: 'DuneSt' project: 'MaterialColors' commitish: 'master' path: 'src';
baseline: 'MaterialColors';
load
```
To add MaterialColors to your baseline just add this:
```Smalltalk
spec
baseline: 'MaterialColors'
with: [ spec repository: 'github://DuneSt/MaterialColors:master/src' ]
```
Note that you can replace the #master by another branch as #development or a tag as #v2.0.0 or #v2.0.? or #v2.x.x .
## Resources
This project aim to help developers to follow Material Design recommandations about colors.
To learn those recommandation please refer to [https://material.io/design/color/](https://material.io/design/color/)
## Smalltalk versions compatibility
| MDL version | Compatible Pharo versions | Compatible Gemstone versions |
|------------- |--------------------------- |--------------------------- |
| 1.0.x | Pharo 50, 60, 61 | None |
| 1.1.x | Pharo 50, 60, 61 | None |
| 1.2.x | Pharo 50, 60, 61 | Gemstone 3.4.x (*) |
| 2.x.x | Pharo 61, 70, 80, 90, 10 | None |
(*) This version of Gemstone is tested. Older versions might work but we did not tested it.
## Contact
If you have any question or problem do not hesitate to open an issue or contact cyril (a) ferlicot.me