Skip to content

Commit

Permalink
Merge pull request #27 from hernando/master
Browse files Browse the repository at this point in the history
Release preparations.
  • Loading branch information
eile committed Nov 5, 2015
2 parents 015515f + 70315a5 commit 3ff6aeb
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 51 deletions.
2 changes: 1 addition & 1 deletion .gitexternals
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
# -*- mode: cmake -*-
# CMake/common https://github.com/Eyescale/CMake.git 77c8475
# CMake/common https://github.com/Eyescale/CMake.git 7f24457
4 changes: 2 additions & 2 deletions .gitsubprojects
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# -*- mode: cmake -*-
git_subproject(Lunchbox https://github.com/Eyescale/Lunchbox.git 01507da)
git_subproject(vmmlib https://github.com/Eyescale/vmmlib.git 2bec113)
git_subproject(Lunchbox https://github.com/Eyescale/Lunchbox.git 7d3b9b2)
git_subproject(vmmlib https://github.com/Eyescale/vmmlib.git 639ccfd)
7 changes: 0 additions & 7 deletions AUTHORS.txt

This file was deleted.

35 changes: 17 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# Brion
[TOC]

# Introduction {#Introduction}

![](doc/BBPLOGO350.jpg)

Expand All @@ -8,8 +10,13 @@ Mesh, Morphology, Synapse and Target files.

Brion can be retrieved by cloning the
[source code](https://github.com/BlueBrain/Brion.git).
The [latest API documentation]
(http://bluebrain.github.io/Brion-1.6/index.html) can be found on
[bluebrain.github.io](http://bluebrain.github.io).

## Features
To keep track of the changes between releases check the [changelog](@ref Changelog).

# Features {#Features}

Brion provides the following major features:

Expand All @@ -31,19 +38,7 @@ Brion provides the following major features:
[Lunchbox](http://eyescale.github.io/Lunchbox-1.8/index.html),
[Boost](http://www.boost.org/doc/libs).

## Building

~~~
git clone https://github.com/BlueBrain/Brion.git
cd Brion
make
~~~

## ChangeLog

To keep track of the changes between releases check the [changelog](doc/Changelog.md).

## About
# Building {#Building}

Brion is a cross-platform library, designed to run on any modern operating
system, including all Unix variants. Brion uses CMake to create a
Expand All @@ -52,6 +47,10 @@ environments are tested:

* Linux: Ubuntu 14.04 and RHEL 6 (Makefile, i386, x64)

The [latest API documentation]
(http://bluebrain.github.io/Brion-1.5/index.html) can be found on
[bluebrain.github.io](http://bluebrain.github.io).
Building from source is as simple as:

git clone https://github.com/BlueBrain/Brion.git
mkdir Brion/build
cd Brion/build
cmake ..
make
36 changes: 15 additions & 21 deletions doc/Changelog.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,27 @@
Changelog {#Changelog}
=========

## git master {master)
<!-- Uncomment at first change # git master {#master) -->

* [#24](https://github.com/BlueBrain/Brion/pull/24):
# Release 1.6.0 (9-Nov-2015)

* [24](https://github.com/BlueBrain/Brion/pull/24):
Add getURI() method in SpikeReport.
* [#9](https://github.com/BlueBrain/Brion/issues/9):
* [22](https://github.com/BlueBrain/Brion/pull/22):
spikeConverter can process spikes to and from stream-type SpikeReport plugins.
* [22](https://github.com/BlueBrain/Brion/pull/22):
SpikeReport DSO plugins in the LD_LIBRARY_PATH are loaded automatically.
* [12](https://github.com/BlueBrain/Brion/pull/12):
Extended brion::Synapse to also support non-merged synapse files
* [12](https://github.com/BlueBrain/Brion/pull/12):
Add brion::Target::parse() to resolve a given target name
* [9](https://github.com/BlueBrain/Brion/issues/9):
Extend SWC parser to support fork and end points and undefined section points.
The Brion::SectionType enum has not been extended to include end and fork
points, these types are translated into the most reasonable one based on the
point ancestors.
* [#12](https://github.com/BlueBrain/Brion/pull/12):
Add brion::Target::parse() to resolve a given target name
* [#12](https://github.com/BlueBrain/Brion/pull/12):
Extended brion::Synapse to also support non-merged synapse files
* [#22](https://github.com/BlueBrain/Brion/pull/22):
SpikeReport DSO plugins in the LD_LIBRARY_PATH are loaded automatically.
* [#22](https://github.com/BlueBrain/Brion/pull/22):
spikeConverter can process spikes to and from stream-type SpikeReport plugins.

## Release 1.5.0 (2015-07-07) {changelog_1_5_0}
# Release 1.5.0 (7-Jul-2015)

* Add RESTING_VOLTAGE constant.
* Add support for binary spike reports.
Expand All @@ -41,7 +43,7 @@ Changelog {#Changelog}
* Replace use of iostreams by lunchbox::MemoryMap.
* Several bugfixes and cleanups.

## Release 1.4.0 (2014-10-08) {changelog_1_4_0}
# Release 1.4.0 (8-Oct-2014)

* Old report readers have been adapted to be static plugins using
lunchbox::IOPluginFactory.
Expand All @@ -54,11 +56,3 @@ Changelog {#Changelog}
Lunchbox::PersistentMap.
* Spike loading has been optimized (in a 12-core GPU the expected
speed-up is above 4x for large files).

## Known Bugs {Bugs}

The following bugs were known at release time. Please file a
[Bug Report](https://github.com/BlueBrain/Brion/issues) if you find
any other issue with this release.

* No known bugs.
4 changes: 2 additions & 2 deletions tests/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
# Change this number when adding tests to force a CMake run: 1

if(NOT BBPTESTDATA_FOUND)
if(RELEASE_VERSION)
message(FATAL_ERROR "Release version requires unit tests")
if(ENABLE_COVERAGE)
message(FATAL_ERROR "Coverage report generation requires test data")
endif()
return()
endif()
Expand Down

0 comments on commit 3ff6aeb

Please sign in to comment.