Merge pull request #12 from ba-st/template

Adjust the basic project files to the template

.smalltalk.ston

@@ -9,10 +9,7 @@ SmalltalkCISpec {
   ],
   #testing : {
     #coverage : {
-       #packages : [  'Mole*' ]
-    },
-    #include : {
-       #packages : [ 'Mole-Tests' ]
+       #packages : [ 'Mole*' ]
     }
   }
 }

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+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.
+
+## Reporting issues
+
+You can report issues [here](https://github.com/ba-st/Mole/issues/new)
+
+## 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.
+
+### 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`
+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 master 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.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 Francisco Ortiz Peñaloza
+Copyright (c) 2018 Francisco Ortiz Peñaloza & 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

README.md

@@ -1,30 +1,37 @@
-![Logo](resources/128.png) Mole
-===============================
-![Latest Release](https://img.shields.io/github/release/ba-st/Mole.svg) [![Build Status](https://travis-ci.org/ba-st/Mole.svg?branch=master)](https://travis-ci.org/ba-st/Mole)
+<p align="center"><img src="assets/logos/128.png">
+ <h1 align="center">Mole</h1>
+  <p align="center">
+    Mole provides a model for graphs, both directed and undirected.
+    <br>
+    <a href="docs/Mole.md"><strong>Explore the docs »</strong></a>
+    <br>
+    <br>
+    <a href="https://github.com/ba-st/Mole/issues/new?labels=Type%3A+Defect">Report a defect</a>
+    |
+    <a href="https://github.com/ba-st/Mole/issues/new?labels=Type%3A+Feature">Request feature</a>
+  </p>
+</p>
+
+[![GitHub release](https://img.shields.io/github/release/ba-st/Mole.svg)](https://github.com/ba-st/Mole/releases/latest)
+[![Build Status](https://travis-ci.org/ba-st/Mole.svg?branch=master)](https://travis-ci.org/ba-st/Mole)
 [![Coverage Status](https://coveralls.io/repos/github/ba-st/Mole/badge.svg?branch=master)](https://coveralls.io/github/ba-st/Mole?branch=master)
 
-*Mole provides a model for graphs, both directed and undirected.*
-
 > *Name origin*: This project started as a topological model, which can be shortened to [**Topo**](https://es.wikipedia.org/wiki/Talpidae), the Spanish word for [Mole](https://en.wikipedia.org/wiki/Mole_(animal)).
 
 ## 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 code is licensed under [MIT](LICENSE).
+- The documentation is licensed under [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/).
+
+## Quick Start
 
-The documentation is licensed under a [Creative Commons Attribution-ShareAlike 4.0 International License](http://creativecommons.org/licenses/by-sa/4.0/).
+- 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/Mole/releases/latest)
+- Explore the [documentation](docs/Mole.md)
 
-## Get started!
+## Installation
 
-- Download a [Pharo Image and VM](http://get.pharo.org)
-- Download a ready to use image of the latest stable version in the [releases page](https://github.com/ba-st/Mole/releases).
-- Check the [documentation](docs/Mole.md)
+To load the project in a Pharo image, or declare it as a dependency of your own project follow this [instructions](docs/Installation.md).
 
-or
-- Open a Playground and evaluate:
+## Contributing
 
-```smalltalk
-Metacello new
-  baseline: 'Mole';
-  repository: 'github://ba-st/Mole:master/source';
-  load
-```
-to get the latest changes.
+Check the [Contribution Guidelines](CONTRIBUTING.md)

docs/Installation.md

@@ -0,0 +1,38 @@
+# Installation
+
+## Basic Installation
+
+You can load **Mole** evaluating:
+```smalltalk
+Metacello new
+	baseline: 'Mole';
+	repository: 'github://ba-st/Mole:master/repository';
+	load.
+```
+>  Change `master` to some released version if you want a pinned version
+
+## Using as dependency
+
+In order to include **Mole** as part of your project, you should reference the package in your product baseline:
+
+```smalltalk
+setUpDependencies: spec
+
+	spec
+		baseline: 'Mole'
+			with: [ spec
+				repository: 'github://ba-st/Mole:v{XX}/source';
+				loads: #('Deployment') ];
+		import: 'Mole'.
+```
+> 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: #('Mole') ] ]
+```