Merge pull request #27 from ba-st/updates

Updates
ba-st · Jan 23, 2019 · f456172 · f456172
2 parents e0727a4 + c289e95
commit f456172
Show file tree

Hide file tree

Showing 13 changed files with 222 additions and 174 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1 @@
-# Better line ending handling for st files
-*.st filter=st_EOL
+*.st linguist-language=Smalltalk
diff --git a/.smalltalk.ston b/.smalltalk.ston
@@ -3,18 +3,13 @@ SmalltalkCISpec {
     SCIMetacelloLoadSpec {
       #baseline : 'RenoirSt',
       #directory : 'source',
-      #load : [ 'Development' ],
+      #load : [ 'CI' ],
       #platforms : [  #pharo ]
     }
   ],
   #testing : {
     #coverage : {
-      #categories : [ 'RenoirSt*' ]
-    },
-    #include : { 
-      #categories : [ 'RenoirSt-Tests*' ]
+       #packages : [ 'RenoirSt*' ]
     }
-
   }
-} 
-
+}
diff --git a/.travis.yml b/.travis.yml
@@ -3,13 +3,13 @@ sudo: false
 os:
 - linux
 smalltalk:
+- Pharo64-8.0
 - Pharo64-7.0
-- Pharo-7.0
-- Pharo-6.1
+- Pharo32-7.0
+- Pharo32-6.1
 matrix:
   allow_failures:
-  - smalltalk: Pharo64-7.0
-  - smalltalk: Pharo-7.0
+  - smalltalk: Pharo64-8.0
   fast_finish: true
 before_deploy:
   - cp "${SMALLTALK_CI_IMAGE}" "RenoirSt.image"

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,47 +1,35 @@
-How to contribute
-=================
+Contributing  
+============
 
-There's several ways to contribute to the project: reporting bugs, sending feedback, proposing ideas for new features, fixing or adding documentation, promoting the project, or even contributing code changes.
+There's several ways to contribute to the project: reporting bugs, sending feedback, proposing ideas for new features, fixing or adding documentation, promoting the project, or even contributing code.
 
-## How to report issues
+## Reporting issues
 
-The issue tracker is this GitHub repository. Please use the labels to categorize the issue.
+You can report issues [here](https://github.com/ba-st/RenoirSt/issues/new)
 
-## How to contribute code
-
-Remember:
-- This project is MIT licensed, so any code contribution must be under the same license.
-- This project uses [semantic versioning](http://semver.org/), so keep it in mind when you make backwards-incompatible changes. If some backwards incompatible change is made the major version MUST be increased.
-- The source code is hosted in this GitHub repository using the tonel format in the `source` folder. The master branch contains the latest changes, feel free to send pull requests or fork the project.
+## Contributing Code
+- This project is MIT licensed, so any code contribution MUST be under the same license.
+- This project uses [Semantic Versioning](http://semver.org/), so keep it in mind when you make backwards-incompatible changes. If some backwards incompatible change is made the major version MUST be increased.
+- The source code is hosted in this repository using the Tonel format in the `source` folder.
+- The master branch contains the latest changes and should always be in a releasable state.
+- Feel free to send pull requests or fork the project.
 - Code contributions without test cases have a lower probability of being merged into the main branch.
 
-
-- Clone this repository or fork it
-- Load the corresponding development version with:
-The development version can be loaded in a Pharo 4/5 image evaluating the following code snippet:
-```smalltalk
-Metacello new
-  baseline: 'RenoirSt';
-  repository: 'tonel://REPO_LOCATION/source';
-  load: 'Development'.
-```
-
-or
-```smalltalk
-Metacello new
-  baseline: 'RenoirSt';
-  repository: 'tonel://REPO_LOCATION/source';
-  load: 'Development-Seaside-Extensions'.
-```
-if you want the Seaside extensions, where `REPO_LOCATION` is the location of the cloned repo in the local file system.
-- Do the changes and save it from Pharo (don't forget to add some test cases)
-- Create a branch, commit using the usual Git tooling and open a Pull Request
-
-## How to contribute documentation
-
-The project documentation is mantained in this GitHub repository in the `docs` folder. To contribute some documentation or improve the existing, feel free to create a branch or fork this repository, make your changes and send a pull request.
-
-Remember the docs are licensed under a CC Attribution-ShareAlike license.
+### Using Iceberg
+1. Download a [Pharo Image and VM](https://get.pharo.org/64)
+2. Clone the project or your fork using Iceberg
+3. Open the Working Copy and using the contextual menu select `Metacello -> Install baseline...`
+4. Input `Development-Seaside-Extensions`
+5. This will load the base code and the test cases
+6. Create a new branch to host your code changes
+7. Do the changes
+8. Run the test cases
+9. Commit and push your changes to the branch using the Iceberg UI
+10. Create a Pull Request against the `release-candidate` branch
+
+## Contributing documentation
+
+The project documentation is maintained in this repository in the `docs` folder and licensed under CC BY-SA 4.0. To contribute some documentation or improve the existing, feel free to create a branch or fork this repository, make your changes and send a pull request.
 
 ### Useful References:
 

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2018 Gabriel Cotelli, RenoirSt and Buenos Aires Smalltalk Contributors
+Copyright (c) 2013-2019 Gabriel Cotelli, RenoirSt and Buenos Aires Smalltalk Contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,86 +1,38 @@
-Renoir.St
-=========
-![GitHub release](https://img.shields.io/github/release/ba-st/RenoirSt.svg)
-[![Build Status](https://travis-ci.org/ba-st/RenoirSt.svg?branch=master)](https://travis-ci.org/ba-st/RenoirSt)
-[![Coverage Status](https://coveralls.io/repos/github/ba-st/RenoirSt/badge.svg?branch=master)](https://coveralls.io/github/ba-st/RenoirSt?branch=master)
+<p align="center"><img src="assets/logos/128x128.png">
+ <h1 align="center">RenoirSt</h1>
+  <p align="center">
+    A DSL enabling programmatic cascading style sheet generation for Pharo Smalltalk
+    <br>
+    <a href="docs/"><strong>Explore the docs »</strong></a>
+    <br>
+    <br>
+    <a href="https://github.com/ba-st/RenoirSt/issues/new?labels=Type%3A+Defect">Report a defect</a>
+    |
+    <a href="https://github.com/ba-st/RenoirSt/issues/new?labels=Type%3A+Feature">Request feature</a>
+  </p>
+</p>
 
-*A DSL enabling programmatic cascading style sheet generation for Pharo Smalltalk*
+![GitHub release](https://img.shields.io/github/release/ba-st/RenoirSt.svg)
+[![Build Status](https://travis-ci.org/ba-st/RenoirSt.svg?branch=release-candidate)](https://travis-ci.org/ba-st/RenoirSt)
+[![Coverage Status](https://coveralls.io/repos/github/ba-st/RenoirSt/badge.svg?branch=release-candidate)](https://coveralls.io/github/ba-st/RenoirSt?branch=release-candidate)
 
 ## Goals
 - Improve CSS integration with existing Web Frameworks
 - Write & refactor in Smalltalk, deploy to CSS
 
-### License:
-The project source code is [MIT](LICENSE) licensed. Any contribution submitted to the code repository is considered to be under the same license.
-
-The documentation is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/)
-
 ### Benefits:
 - Keep in sync your code changes with the changes in the CSS
 - Use your favorite browsing and refactoring tools inside the same Pharo image to handle CSS  
 
-### Highlights:
-- **Supported Platforms**: [Pharo 3 / Pharo 4 / Pharo 5 / Pharo 6 / Pharo 7](http://www.pharo.org/)
-- **Source Code Repository** and **Issue Tracking**: In this GitHub repository.
-
-### Get started!
-
-#### Pharo 6/7
-
-- Open a Playground and evaluate:
-
-```smalltalk
-Metacello new
-  baseline: 'RenoirSt';
-  repository: 'github://ba-st/RenoirSt:master/source';
-  load
-```
-
-
-#### Pharo 5
-
-- Open a Playground and evaluate:
-
-```smalltalk
-Metacello new
-  baseline: 'RenoirSt';
-  repository: 'github://ba-st/RenoirSt:stable-pharo-50/source';
-  load
-```
-
-or
+## License
+- The code is licensed under [MIT](LICENSE).
+- The documentation is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).
 
-- Load it using the Catalog Browser
+## Quick Start
 
-#### Pharo 4
-
-- Open a Playground and evaluate:
-
-```smalltalk
-Metacello new
-  baseline: 'RenoirSt';
-  repository: 'github://ba-st/RenoirSt:stable-pharo-40/source';
-  load
-```
-
-or
-
-- Load it using the Configuration Browser
-
-#### Pharo 3 (this version is stalled at 1.4.0)
-
-- Load it using the Configuration Browser
-
-or
-
-- Open a workspace and evaluate:
-
-```smalltalk
-Gofer it    
-    url: 'http://smalltalkhub.com/mc/gcotelli/RenoirSt/main';
-    configurationOf: 'RenoirSt';
-    loadStable
-```
+- Download the latest [Pharo 32](https://get.pharo.org/) or [64 bits VM](https://get.pharo.org/64/).
+- Download a ready to use image from the [release page](https://github.com/ba-st/RenoirSt/releases/latest)
+- Explore the [documentation](docs/)
 
 ***********************************************
 
@@ -100,5 +52,11 @@ body::before
 	content: "Hello World";
 }
 ```
-### Contributing
-If you want to help check the ["How to contribute" doc](CONTRIBUTING.md)
+
+## Installation
+
+To load the project in a Pharo image, or declare it as a dependency of your own project follow this [instructions](docs/Installation.md).
+
+## Contributing
+
+Check the [Contribution Guidelines](CONTRIBUTING.md)
diff --git a/docs/How to release a new version.md b/docs/How to release a new version.md
diff --git a/docs/Installation.md b/docs/Installation.md
@@ -0,0 +1,95 @@
+# Installation
+
+## Basic Installation
+
+### Pharo 6.1 or greater
+
+You can load **RenoirSt** evaluating:
+```smalltalk
+Metacello new
+	baseline: 'RenoirSt';
+	repository: 'github://ba-st/RenoirSt:release-candidate/source';
+	load.
+```
+>  Change `release-candidate` to some released version if you want a pinned version
+
+### Pharo 5
+
+- Open a Playground and evaluate:
+
+```smalltalk
+Metacello new
+  baseline: 'RenoirSt';
+  repository: 'github://ba-st/RenoirSt:stable-pharo-50/source';
+  load
+```
+
+or
+
+- Load it using the Catalog Browser
+
+### Pharo 4
+
+- Open a Playground and evaluate:
+
+```smalltalk
+Metacello new
+  baseline: 'RenoirSt';
+  repository: 'github://ba-st/RenoirSt:stable-pharo-40/source';
+  load
+```
+
+or
+
+- Load it using the Configuration Browser
+
+### Pharo 3 (this version is stalled at 1.4.0)
+
+- Load it using the Configuration Browser
+
+or
+
+- Open a workspace and evaluate:
+
+```smalltalk
+Gofer it    
+    url: 'http://smalltalkhub.com/mc/gcotelli/RenoirSt/main';
+    configurationOf: 'RenoirSt';
+    loadStable
+```
+
+## Using as dependency
+
+In order to include **RenoirSt** as part of your project, you should reference the package in your product baseline:
+
+```smalltalk
+setUpDependencies: spec
+
+	spec
+		baseline: 'RenoirSt'
+			with: [ spec
+				repository: 'github://ba-st/RenoirSt:v{XX}/source';
+				loads: #('Deployment') ];
+		import: 'RenoirSt'.
+```
+> Replace `{XX}` with the version you want to depend on
+
+```smalltalk
+baseline: spec
+
+	<baseline>
+	spec
+		for: #common
+		do: [ self setUpDependencies: spec.
+			spec package: 'My-Package' with: [ spec requires: #('RenoirSt') ] ]
+```
+
+## Provided groups
+
+- `Deployment` will load all the packages needed in a deployed application
+- `Tests` will load the test cases
+- `Tools` will load the extensions to the SUnit framework and development tools (inspector and spotter extensions)
+- `CI` is the group loaded in the continuous integration setup
+- `Development` will load all the needed packages to develop and contribute to the project
+- `Deployment-Seaside-Extensions` will load all the packages needed in a deployed application including the Javascript extensions
+- `Development-Seaside-Extensions` will load all the needed packages to develop and contribute to the project including the Javascript extensions
diff --git a/docs/tutorial/Tutorial - Part I.md → docs/tutorial/Tutorial-Part-I.md b/docs/tutorial/Tutorial - Part I.md → docs/tutorial/Tutorial-Part-I.md
diff --git a/docs/tutorial/Tutorial - Part II.md → docs/tutorial/Tutorial-Part-II.md b/docs/tutorial/Tutorial - Part II.md → docs/tutorial/Tutorial-Part-II.md
diff --git a/docs/tutorial/Tutorial - Part III.md → docs/tutorial/Tutorial-Part-III.md b/docs/tutorial/Tutorial - Part III.md → docs/tutorial/Tutorial-Part-III.md
diff --git a/docs/tutorial/Tutorial - TOC.md → docs/tutorial/Tutorial-TOC.md b/docs/tutorial/Tutorial - TOC.md → docs/tutorial/Tutorial-TOC.md
@@ -2,10 +2,10 @@ Tutorial
 ========
 
 ### Table Of Contents
-- [Part I](Tutorial - Part I.md)
+- [Part I](Tutorial-Part-I.md)
   - Introduction
   - Basics
-- [Part II](Tutorial - Part II.md)
+- [Part II](Tutorial-Part-II.md)
   - Selectors
     - Type Selectors
     - Combinators
@@ -14,7 +14,7 @@ Tutorial
     - Pseudo-Classes
     - Pseudo-Elements
 	- Selector Groups
-- [Part III](Tutorial - Part III.md )
+- [Part III](Tutorial-Part-III.md )
   - Important Rules
   - Media Queries
   - Vendor specific extensions