Skip to content
Snippets Groups Projects
Commit eb14d1cd authored by Tiago Grego's avatar Tiago Grego
Browse files

add basic info to readme

parent 593e9bc6
No related branches found
No related tags found
2 merge requests!449add basic info to readme,!457Patch to support longer assembly names in the mapping session table.
......@@ -6,4 +6,39 @@
[travis]: https://travis-ci.org/Ensembl/ensembl
[coveralls]: https://coveralls.io/github/Ensembl/ensembl
The Ensembl Core API (Application Programme Interface) serves as a middle layer between the underlying MySQL database and the user's script. It aims to encapsulate the database layout by providing high level access to the database.
Find more information (including the installation guide and a tutorial) on the Ensembl website: http://www.ensembl.org/info/docs/api/core/
## Download
To clone the Ensembl Core API, use the following command:
```
git clone https://github.com/Ensembl/ensembl.git
```
## API requirements
In order to use the Ensembl Core API, an installation of [BioPerl 1.6.924 core modules](https://github.com/bioperl/bioperl-live/archive/release-1-6-924.zip) (bioperl-live) is required.
A guide for installing all Ensembl APIs and their respective prerequisites is available here:
http://www.ensembl.org/info/docs/api/api_installation.html
## API tutorial
An extensive tutorial for the Ensembl Core API can be found at:
http://www.ensembl.org/info/docs/api/core/core_tutorial.html
## Contributions
If you wish to contribute to this repository or any Ensembl repository, please refer to [our contribution guide](https://github.com/Ensembl/ensembl/blob/master/CONTRIBUTING.md).
## Contact us
Please email comments or questions to the public Ensembl developers list at
<http://lists.ensembl.org/mailman/listinfo/dev>.
Questions may also be sent to the Ensembl help desk at
<http://www.ensembl.org/Help/Contact>.
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment