Skip to content

Commit 8cf3595

Browse files
authored
Merge pull request #48 from ba-st/pharo_10
Add Pharo 10
2 parents c9119ee + 99825c0 commit 8cf3595

22 files changed

+226
-194
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
*.st linguist-language=Smalltalk
2+
*.st eol=lf
3+
*.st text diff

.github/workflows/loading-groups.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jobs:
88
strategy:
99
fail-fast: false
1010
matrix:
11-
smalltalk: [ Pharo64-9.0, Pharo64-8.0 ]
11+
smalltalk: [ Pharo64-10, Pharo64-9.0, Pharo64-8.0 ]
1212
load-spec: [ deployment, deployment-seaside-extensions, tests, tools, development, development-seaside-extensions ]
1313
name: ${{ matrix.smalltalk }} + ${{ matrix.load-spec }}
1414
steps:

.github/workflows/unit-tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ jobs:
77
runs-on: ubuntu-latest
88
strategy:
99
matrix:
10-
smalltalk: [ Pharo64-9.0, Pharo64-8.0, Pharo64-7.0, Pharo32-7.0 ]
10+
smalltalk: [ Pharo64-10, Pharo64-9.0, Pharo64-8.0, Pharo64-7.0, Pharo32-7.0 ]
1111
name: ${{ matrix.smalltalk }}
1212
steps:
1313
- uses: actions/checkout@v2

CONTRIBUTING.md

Lines changed: 14 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Contributing
1+
# Contributing
22

3-
There's several ways to contribute to the project: reporting bugs, sending
3+
There are several ways to contribute to the project: reporting bugs, sending
44
feedback, proposing ideas for new features, fixing or adding documentation,
55
promoting the project, or even contributing code.
66

@@ -11,30 +11,24 @@ You can report issues [here](https://github.com/ba-st/RenoirSt/issues/new)
1111
## Contributing Code
1212

1313
- This project is MIT licensed, so any code contribution MUST be under the same license.
14-
- This project uses [Semantic Versioning](http://semver.org/), so keep it in mind
15-
when you make backwards-incompatible changes. If some backwards incompatible
16-
change is made the major version MUST be increased.
14+
- This project uses [Semantic Versioning](http://semver.org/), so keep it in
15+
mind when you make backwards-incompatible changes. If some backwards
16+
incompatible change is made the major version MUST be increased.
1717
- The source code is hosted in this repository using the Tonel format in the
1818
`source` folder.
19-
- The master branch contains the latest changes and should always be in a
20-
releasable state.
19+
- The `release-candidate` branch contains the latest changes and should always
20+
be in a releasable state.
2121
- Feel free to send pull requests or fork the project.
2222
- Code contributions without test cases have a lower probability of being merged
2323
into the main branch.
2424

25-
### Using Iceberg
26-
27-
1. Download a [Pharo Image and VM](https://get.pharo.org/64)
28-
2. Clone the project or your fork using Iceberg
29-
3. Open the Working Copy and using the contextual menu select
30-
`Metacello -> Install baseline...`
31-
4. Input `Development-Seaside-Extensions`
32-
5. This will load the base code and the test cases
33-
6. Create a new branch to host your code changes
34-
7. Do the changes
35-
8. Run the test cases
36-
9. Commit and push your changes to the branch using the Iceberg UI
37-
10. Create a Pull Request against the `release-candidate` branch
25+
1. [Load the project code in a Pharo image](docs/how-to/how-to-load-in-pharo.md)
26+
2. Create a new branch to host your code changes
27+
3. Do the changes
28+
4. Run the test cases
29+
5. Commit and push your changes to the branch using the Iceberg UI. You may need
30+
to add your fork if lacking the required permissions to push to the main repo.
31+
6. Create a Pull Request against the `release-candidate` branch
3832

3933
## Contributing documentation
4034

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2013-2021 Gabriel Cotelli, RenoirSt and Buenos Aires Smalltalk Contributors
3+
Copyright (c) 2013-2022 Gabriel Cotelli, RenoirSt and Buenos Aires Smalltalk Contributors
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,12 @@ A DSL enabling programmatic cascading style sheet generation for Pharo Smalltalk
1313
[![Pharo 6.1](https://img.shields.io/badge/Pharo-6.1-informational)](https://pharo.org)
1414
[![Pharo 7.0](https://img.shields.io/badge/Pharo-7.0-informational)](https://pharo.org)
1515
[![Pharo 8.0](https://img.shields.io/badge/Pharo-8.0-informational)](https://pharo.org)
16+
[![Pharo 9.0](https://img.shields.io/badge/Pharo-9.0-informational)](https://pharo.org)
17+
[![Pharo 10](https://img.shields.io/badge/Pharo-10-informational)](https://pharo.org)
1618

17-
Quick links
19+
## Quick links
1820

19-
- [**Explore the docs**](docs/)
21+
- [**Explore the docs**](docs/README.md)
2022
- [Report a defect](https://github.com/ba-st/RenoirSt/issues/new?labels=Type%3A+Defect)
2123
- [Request a feature](https://github.com/ba-st/RenoirSt/issues/new?labels=Type%3A+Feature)
2224

@@ -36,11 +38,9 @@ Quick links
3638
- The code is licensed under [MIT](LICENSE).
3739
- The documentation is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).
3840

39-
## Quick Start
41+
## Installation
4042

41-
- Download the latest [Pharo 32](https://get.pharo.org/) or [64 bits VM](https://get.pharo.org/64/).
42-
- Download a ready to use image from the [release page](https://github.com/ba-st/RenoirSt/releases/latest)
43-
- Explore the [documentation](docs/)
43+
To load the project in a Pharo image follow this [instructions](docs/how-to/how-to-load-in-pharo.md).
4444

4545
***********************************************
4646

@@ -62,11 +62,6 @@ body::before
6262
}
6363
```
6464

65-
## Installation
66-
67-
To load the project in a Pharo image, or declare it as a dependency of your own
68-
project follow this [instructions](docs/Installation.md).
69-
7065
## Contributing
7166

7267
Check the [Contribution Guidelines](CONTRIBUTING.md)

docs/Installation.md

Lines changed: 0 additions & 112 deletions
This file was deleted.

docs/README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# RenoirSt Documentation
2+
3+
A DSL enabling programmatic cascading style sheet generation for Pharo Smalltalk.
4+
5+
To learn about the project, [install it](how-to/how-to-load-in-pharo.md) and
6+
follow the [tutorial](tutorial/Tutorial-TOC.md).
7+
8+
---
9+
10+
To use the project as a dependency of your project, take a look at:
11+
12+
- [How to use RenoirSt as a dependency](how-to/how-to-use-as-dependency-in-pharo.md)
13+
- [Baseline groups reference](reference/Baseline-groups.md)
Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
# How to load RenoirSt in a Pharo image
2+
3+
## Pharo 6.1 or greater
4+
5+
### Using Metacello
6+
7+
1. Download a [Pharo VM and image](https://pharo.org/download)
8+
2. Open your Pharo image
9+
3. Open a Playground
10+
4. Evaluate:
11+
12+
```smalltalk
13+
Metacello new
14+
baseline: 'RenoirSt';
15+
repository: 'github://ba-st/RenoirSt:release-candidate';
16+
load: 'Development'.
17+
```
18+
19+
> Change `release-candidate` to some released version if you want a pinned version
20+
21+
### Using Iceberg
22+
23+
1. Download [pharo VM and image](https://pharo.org/download)
24+
2. Open your Pharo image
25+
3. Open Iceberg
26+
4. Click the *Add* repository button
27+
5. Select *Clone from github.com* and enter `ba-st` as owner name and `RenoirSt`
28+
as project name
29+
6. Click *Ok*
30+
7. Select the repository in the main Iceberg window
31+
8. Open the contextual menu and select
32+
*Metacello -> Install baseline of RenoirSt ...*
33+
9. Type `Development` and click *Ok*
34+
35+
> After Iceberg cloned a repository, it will be checked-out at the default
36+
> branch (in this case `release-candidate`). If you want to work on a different
37+
> branch or commit, perform the checkout before the baseline installation step.
38+
39+
## Pharo 5
40+
41+
- Open a Playground and evaluate:
42+
43+
```smalltalk
44+
Metacello new
45+
baseline: 'RenoirSt';
46+
repository: 'github://ba-st/RenoirSt:stable-pharo-50/source';
47+
load
48+
```
49+
50+
or
51+
52+
- Load it using the Catalog Browser
53+
54+
## Pharo 4
55+
56+
- Open a Playground and evaluate:
57+
58+
```smalltalk
59+
Metacello new
60+
baseline: 'RenoirSt';
61+
repository: 'github://ba-st/RenoirSt:stable-pharo-40/source';
62+
load
63+
```
64+
65+
or
66+
67+
- Load it using the Configuration Browser
68+
69+
## Pharo 3 (this version is stalled at 1.4.0)
70+
71+
- Load it using the Configuration Browser
72+
73+
or
74+
75+
- Open a workspace and evaluate:
76+
77+
```smalltalk
78+
Gofer it
79+
url: 'http://smalltalkhub.com/mc/gcotelli/RenoirSt/main';
80+
configurationOf: 'RenoirSt';
81+
loadStable
82+
```
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# How to use RenoirSt as dependency in a Pharo product
2+
3+
In order to include **RenoirSt** as part of your project, you should reference
4+
the package in your product baseline:
5+
6+
1. Define the RenoirSt repository and version to be used, and the [baseline groups](../reference/Baseline-groups.md)
7+
you want to depend on (usually it will be `Deployment`).
8+
9+
If you're unsure on what to depend use the *Dependency Analyzer*
10+
tool to choose an appropriate group including the packages you need.
11+
12+
2. Create a method like this one in the baseline class of your product:
13+
14+
```smalltalk
15+
setUpDependencies: spec
16+
17+
spec
18+
baseline: 'RenoirSt'
19+
with: [ spec repository: 'github://github://ba-st/RenoirSt:v{XX}' ];
20+
project: 'RenoirSt-Deployment'
21+
copyFrom: 'RenoirSt' with: [ spec loads: 'Deployment' ]
22+
```
23+
24+
This will create `RenoirSt-Deployment` as a valid target that can be used
25+
as requirement in your own packages.
26+
27+
> Replace `{XX}` with the version you want to depend on
28+
29+
3. Use the new loading target as a requirement on your packages. For example:
30+
31+
```smalltalk
32+
baseline: spec
33+
34+
<baseline>
35+
spec
36+
for: #pharo
37+
do: [
38+
self setUpDependencies: spec.
39+
spec
40+
package: 'My-Package'
41+
with: [ spec requires: #('RenoirSt-Deployment') ] ]
42+
```

0 commit comments

Comments
 (0)