From be593694eea1d5f049c27fe548c8cef0c4b6e0f6 Mon Sep 17 00:00:00 2001 From: Martin Dias Date: Sun, 7 Jul 2024 18:17:16 -0400 Subject: [PATCH] Pass on README - Add link to branch and contribution workflow - Homogeinize README with Bloc: not install scripts are in the wiki, with a link from README --- README.md | 24 ++++++------------------ 1 file changed, 6 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 28ad3a9..915e7e6 100644 --- a/README.md +++ b/README.md @@ -3,35 +3,23 @@ [![Tests](https://github.com/pharo-graphics/Album/actions/workflows/Tests.yml/badge.svg?branch=master)](https://github.com/pharo-graphics/Album/actions/workflows/Tests.yml) [![Pharo 11](https://img.shields.io/badge/Pharo-11-%23aac9ff.svg)](https://pharo.org/download) [![Pharo 12](https://img.shields.io/badge/Pharo-12-%23aac9ff.svg)](https://pharo.org/download) +[![Pharo 13](https://img.shields.io/badge/Pharo-13-%23aac9ff.svg)](https://pharo.org/download) # Album -Album is a text editor library based on Bloc. +Album is a text editor library based on [Bloc](https://github.com/pharo-graphics/Bloc). Album provide functions to create widgets with advanced text edition features as input field, text area, etc. Originaly forked from Brick project editor. -## Installation +## Install -Load the stable Album in current stable Pharo with: +The project can be loaded as usual via Metacello, using the `BaselineOfAlbum` specification. To copy/paste a loading script, see the [wiki page](../../wiki/Install). -```Smalltalk -Metacello new - baseline: 'Album'; - repository: 'github://pharo-graphics/Album:master/src'; - onConflictUseIncoming; - load -``` - -Add Album to your project Baseline with: - -```Smalltalk -spec baseline: 'Album' with: [ spec repository: 'github://pharo-graphics/Album:master/src' ]. -``` - -For development, replace `master` by `dev` in previous code. +## Branches & Contributions +We describe our contribution workflow & branch name convention in [this wiki page](../../wiki/Branches-and-versions). ## License