Skip to content

Commit cb2f6cf

Browse files
committed
Improve the readme
- Correct some style problems - Add syntax highlighting - Explain version management - Add contact infos
1 parent e5a9613 commit cb2f6cf

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,51 @@
11
# MaterialColors
22

3-
####Linux/OSX builds
3+
#### Linux/OSX builds
44
Master: [![Build Status](https://travis-ci.org/DuneSt/MaterialColors.svg?branch=master)](https://travis-ci.org/DuneSt/MaterialColors)
55

6-
####Windows builds
6+
#### Windows builds
77
Master: [![Build status](https://ci.appveyor.com/api/projects/status/3dn6m0k68jjenk6v/branch/master?svg=true)](https://ci.appveyor.com/project/jecisc/materialcolors/branch/master) | Latest commit: [![Build status](https://ci.appveyor.com/api/projects/status/3dn6m0k68jjenk6v?svg=true)](https://ci.appveyor.com/project/jecisc/materialcolors)
88

99
A project to extends Pharo colors's classes with the Material Design recommandations
1010

11+
12+
# Documentation
13+
14+
## Version management
15+
16+
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`.
17+
18+
- **X** define the major version number
19+
- **Y** define the minor version number
20+
- **Z** define the patch version number
21+
22+
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.
23+
24+
Thus, it should be safe to depend on a fixed major version and moving minor version of this project.
25+
1126
## Install MaterialColors
1227

1328
To install MaterialColors on your Pharo image you can just execute the following script:
1429

30+
```Smalltalk
1531
Metacello new
1632
githubUser: 'DuneSt' project: 'MaterialColors' commitish: 'master' path: 'src';
1733
baseline: 'MaterialColors';
1834
onWarningLog;
1935
load
36+
```
2037

2138
To add MaterialColors to your baseline just add this:
2239

40+
```Smalltalk
2341
spec
2442
baseline: 'MaterialColors'
2543
with: [ spec repository: 'github://DuneSt/MaterialColors:master/src' ]
44+
```
2645
27-
Note that you can replace the #master by another branch as #development or a tag as #v1.0.0.
46+
Note that you can replace the #master by another branch as #development or a tag as #v1.0.0 or #v1.0.? or #v1.x.x .
47+
2848

49+
## Contact
2950

51+
If you have any question or problem do not hesitate to open an issue or contact cyril (a) ferlicot.me

0 commit comments

Comments
 (0)