From 103d5e7367d1bf40d0f826c29c965b0ed266cd0f Mon Sep 17 00:00:00 2001 From: CyrilFerlicot Date: Thu, 23 Feb 2023 15:25:46 +0100 Subject: [PATCH] readme --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index b4b8727..15f6397 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,40 @@ # random-numbers + +[![CI](https://github.com/PolyMathOrg/random-numbers/actions/workflows/continuous.yml/badge.svg)](https://github.com/PolyMathOrg/random-numbers/actions/workflows/continuous.yml) +[![Coverage Status](https://coveralls.io/repos/github/PolyMathOrg/random-numbers/badge.svg?branch=main)](https://coveralls.io/github/PolyMathOrg/random-numbers?branch=main) +[![Pharo version](https://img.shields.io/badge/Pharo-11-%23aac9ff.svg)](https://pharo.org/download) +[![Pharo version](https://img.shields.io/badge/Pharo-10-%23aac9ff.svg)](https://pharo.org/download) +[![Pharo version](https://img.shields.io/badge/Pharo-9-%23aac9ff.svg)](https://pharo.org/download) + Project to provide different random number generators for the Pharo programming language + +## Installation + +To install this project on your Pharo image, execute the following script: + +```Smalltalk +Metacello new + githubUser: 'PolyMathOrg' project: 'random-numbers' commitish: 'v1.x.x' path: 'src'; + baseline: 'MathRandomNumbers'; + load +``` + +To add TinyLogger to your baseline: + +```Smalltalk +spec + baseline: 'MathRandomNumbers' + with: [ spec repository: 'github://PolyMathOrg/random-numbers:v1.x.x/src' ] +``` + +Note you can replace the #master by another branch such as #development or a tag such as #v1.0.0, #v1.? or #v1.2.? . + +## Quick start + +> TODO + +## Smalltalk versions compatibility + +| Version | Compatible Pharo versions | +|------------- |------------------------------| +| 1.x.x | Pharo 90, 10, 11 |