brainglobe / brainrender

a python based software for visualization of neuroanatomical and morphological data.
https://brainglobe.info/documentation/brainrender/index.html
BSD 3-Clause "New" or "Revised" License
538 stars 75 forks source link

Readme Overhaul #337

Closed paulbrodersen closed 4 months ago

paulbrodersen commented 4 months ago

Description

What is this PR

Why is this PR needed?

The current README is outdated and very terse.

What does this PR do?

I have made the following changes:

The result can be inspected here.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 86.47%. Comparing base (1ff1a5e) to head (fc2c71e).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #337 +/- ## ======================================= Coverage 86.47% 86.47% ======================================= Files 27 27 Lines 1220 1220 ======================================= Hits 1055 1055 Misses 165 165 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.