Skip to content

Commit f59f6c7

Browse files
authored
Improve README
1 parent 54c168c commit f59f6c7

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

README.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,35 @@
1212
</p>
1313
</p>
1414

15-
[![CI matrix](actions/workflows/test.yml/badge.svg)](actions/workflows/test.yml)
15+
[![CI](https://github.com/PolyMathOrg/PolyMath-DataStructures/actions/workflows/test.yml/badge.svg)](https://github.com/PolyMathOrg/PolyMath-DataStructures/actions/workflows/test.yml)
1616
[![Coverage Status](https://coveralls.io/repos/github/PolyMathOrg/PolyMath-DataStructures/badge.svg?branch=master)](https://coveralls.io/github/PolyMathOrg/PolyMath-DataStructures?branch=master)
1717
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/PolyMathOrg/PolyMath-DataStructures/master/LICENSE)
18+
19+
## Description
20+
21+
A project to manage the data structures of PolyMaths. It currently includes the Vector and Matrix Pharo implementation.
22+
23+
## Installation
24+
25+
You can load all the packages into a fresh Pharo image by going to the Playground (Ctrl + OW/Cmd + OW) and executing the following expression (select it and press Do-it button or Ctrl+D/Cmd+D):
26+
27+
```smalltalk
28+
Metacello new
29+
baseline: 'PolyMathDataStructures';
30+
repository: 'github://PolyMathOrg/PolyMath-DataStructures/src';
31+
onWarningLog;
32+
onConflictUseIncoming;
33+
load ]
34+
```
35+
36+
This should load the default version of the project (you can also specify another version or branch).
37+
38+
To add it to your Baseline:
39+
40+
```smalltalk
41+
spec
42+
baseline: 'PolyMathDataStructures'
43+
with: [ spec repository: 'github://PolyMathOrg/PolyMath-DataStructures/src' ]
44+
```
45+
46+
If you are new to baselines and Metacello, check out the [Baselines](https://github.com/pharo-open-documentation/pharo-wiki/blob/master/General/Baselines.md) tutorial on Pharo Wiki.

0 commit comments

Comments
 (0)