Skip to content

Commit 7ac9ad7

Browse files
committed
Merge f9411c0
2 parents b4d30f1 + f9411c0 commit 7ac9ad7

File tree

1 file changed

+50
-12
lines changed

1 file changed

+50
-12
lines changed

README.md

Lines changed: 50 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,68 @@ BioSmalltalk is an Open-Source (MIT-licensed) library for Bioinformatics using S
1818

1919
# Installation
2020

21-
There are several ways to install **BioSmalltalk**. At minimum, you need a working Pharo virtual image installed in a system. Check the [Pharo website](http://www.pharo.org) for installation information regarding the Pharo Open-Source system. To paste the following expressions inside Pharo, open a "Playground" window with (Cmd + O + I) or by clicking an empty area in the Pharo window and select Tools -> Playground.
21+
There are several ways to install **BioSmalltalk**. At minimum, you need a working Pharo virtual image installed in a system. Check the [Pharo website](http://www.pharo.org) for installation information regarding the Pharo Open-Source system. You can also two use one-liners: `bash -c "$(curl -fsSL https://raw.githubusercontent.com/hernanmd/pi/master/install.sh)"` to install PI (Pharo Install CLI) and `pi lrun` to install the latest Pharo image. To paste the following expressions inside Pharo, open a "Playground" window with (Cmd + O + I) or by clicking an empty area in the Pharo window and select Tools -> Playground.
2222

2323
To evaluate a expression, click on the upper right green arrow or highlight the script code and right click for options.
2424

25-
For additional help using Pharo please check the excellent [free Pharo books](http://books.pharo.org/), the [awesome-pharo lists](https://github.com/pharo-open-documentation/awesome-pharo) and the [wiki](https://github.com/pharo-open-documentation/pharo-wiki).
25+
For additional help using Pharo please check the [free Pharo books](http://books.pharo.org/), the [awesome-pharo lists](https://github.com/pharo-open-documentation/awesome-pharo) and the [wiki](https://github.com/pharo-open-documentation/pharo-wiki).
2626
For a quick reference of the syntax, check the [Pharo Cheat Sheet](http://files.pharo.org/media/pharoCheatSheet.pdf)
2727

2828
## Standard Installation
2929

30-
You can uncomment the specific loading group in the following expression by removing the # prepended character, and add it to the group currently uncommented. Check the installation matrix above to know about the options. The script should be evaluated inside the Pharo image. The current Pharo version 8.x is supported.
30+
The script should be evaluated inside the Pharo image. The current Pharo version 13.x is supported.
3131

3232
```smalltalk
33-
EpMonitor disableDuring: [
34-
Metacello new
35-
onConflictUseLoaded;
36-
onWarningLog;
37-
repository: 'github://hernanmd/biosmalltalk/repository';
38-
baseline: 'BioSmalltalk';
39-
load ].
33+
EpMonitor disableDuring: [
34+
Metacello new
35+
onConflictUseLoaded;
36+
onWarningLog;
37+
repository: 'github://hernanmd/biosmalltalk/repository';
38+
baseline: 'BioSmalltalk';
39+
load ].
4040
```
4141
In case of problems check [Troubleshoot Install](./TROUBLESHOOT.md)
4242

43-
## Baseline String
43+
# Contribute
4444

45-
If you want to add BioSmalltalk to your Metacello Baselines or Configurations, copy and paste the following expression:
45+
**Working on your first Pull Request?** You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
4646

47+
If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.
48+
If you have any suggestions for how this package could be improved, please get in touch or suggest an improvement using the GitHub issues page.
49+
If you'd like to make some changes yourself, see the following:
50+
51+
- Fork this repository to your own GitHub account and then clone it to your local device
52+
- Do some modifications
53+
- Test.
54+
- Add <your GitHub username> to add yourself as author below.
55+
- Finally, submit a pull request with your changes!
56+
- This project follows the [all-contributors specification](https://github.com/kentcdodds/all-contributors). Contributions of any kind are welcome!
57+
58+
## Version management
59+
60+
This project use semantic versioning to define the releases. This means that each stable release of the project will be assigned a version number of the form `vX.Y.Z`.
61+
62+
- **X** defines the major version number
63+
- **Y** defines the minor version number
64+
- **Z** defines the patch version number
65+
66+
When a release contains only bug fixes, the patch number increases. When the release contains new features that are backward compatible, the minor version increases. When the release contains breaking changes, the major version increases.
67+
68+
Thus, it should be safe to depend on a fixed major version and moving minor version of this project.
69+
70+
# License
71+
72+
This software is licensed under the MIT License.
73+
74+
Copyright Hernán Morales Durand, 2025.
75+
76+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
77+
78+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
79+
80+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
81+
82+
# Authors
83+
84+
Hernán Morales Durand
4785

0 commit comments

Comments
 (0)