Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme Overhaul #337

Merged
merged 20 commits into from
Apr 19, 2024
Merged

Readme Overhaul #337

merged 20 commits into from
Apr 19, 2024

Conversation

paulbrodersen
Copy link
Contributor

@paulbrodersen paulbrodersen commented Apr 19, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?

The current README is outdated and very terse.

What does this PR do?

I have made the following changes:

  • Removed the old images as they had a very low ink-to-information ratio; added an image from the paper with a high ink-to-information ratio as a placeholder. I don't think this particular image should be used long-term but it is better than the previous ones and can serve as a template for a new and improved gallery image. However, I lack both time and the data to make one, so someone else would have to step in.
  • Removed outdated badges (GPLv3; Black); added a new "Downloads" badge as "social proof" (corny, but so are all badges and it helps).
  • Added a "Quickstart" section demonstrating the basic workflow.
  • Added a BibTeX entry to the "Citing BrainRender" section.
  • Added additional context to the "Documentation" section (who or what is BrainGlobe and why does it host the BrainRender documentation?).
  • Shortened the tag line, so it's a tag line and not an essay.

The result can be inspected here.

@adamltyson adamltyson self-requested a review April 19, 2024 12:30
Copy link

codecov bot commented Apr 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@adamltyson adamltyson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @paulbrodersen. I left a few small comments.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
paulbrodersen and others added 3 commits April 19, 2024 15:59
Co-authored-by: Adam Tyson <code@adamltyson.com>
Co-authored-by: Adam Tyson <code@adamltyson.com>
Co-authored-by: Adam Tyson <code@adamltyson.com>
@adamltyson adamltyson self-requested a review April 19, 2024 15:21
@adamltyson adamltyson merged commit f3103ba into brainglobe:main Apr 19, 2024
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants