Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
AhmetNSimsek committed Dec 19, 2024
1 parent b42f657 commit 70322be
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
==============================================================
siibra - Software interface for interacting with brain atlases
==============================================================

Copyright 2020-2024, Forschungszentrum Jülich GmbH

*Authors: Big Data Analytics Group, Institute of Neuroscience and
Medicine (INM-1), Forschungszentrum Jülich GmbH*

This repository contains the default configuration of `siibra-python <https://github.com/FZJ-INM1-BDA/siibra-python>`.

Tag scheme
==========
Given a tag siibra-MAJOR.MINOR.PATCH, increments imply:
- MAJOR: incompatible API changes
- MINOR: a functionality in a backward compatible manner is added
- PATCH: backward compatible bug fixes and new configuration added such as new maps or features

Pre-release
-----------
For x.y.z, a full release,
- `x.y.z-alpha.t` is the development prerelease. By changing `t`, different siibra-configurations are targeted.

0 comments on commit 70322be

Please sign in to comment.