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

[MRG] Add sourmash logo to docs and README #1127

Merged
merged 5 commits into from
Jul 26, 2020
Merged

[MRG] Add sourmash logo to docs and README #1127

merged 5 commits into from
Jul 26, 2020

Conversation

luizirber
Copy link
Member

@luizirber luizirber commented Jul 25, 2020

Fixes #673

I also removed the customized template for the docs, opting for using the one that comes by default with Alabaster. It is a bit different (for example, "Navigation" instead of "Table of Contents" in the sidebar), but this way we don't need to keep updating our copy when the one from the theme is updated.

TODO:

  • fix logo URL in README before merge
  • Credit the logo author (Stéfanie)

Checklist

  • Is it mergeable?
  • make test Did it pass the tests?
  • make coverage Is the new code covered?
  • Did it change the command-line interface? Only additions are allowed
    without a major version increment. Changing file formats also requires a
    major version number increment.
  • Was a spellchecker run on the source code and documentation after
    changes were made?

@codecov
Copy link

codecov bot commented Jul 25, 2020

Codecov Report

Merging #1127 into master will increase coverage by 9.25%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1127      +/-   ##
==========================================
+ Coverage   83.79%   93.04%   +9.25%     
==========================================
  Files          98       74      -24     
  Lines        9063     5810    -3253     
==========================================
- Hits         7594     5406    -2188     
+ Misses       1469      404    -1065     
Flag Coverage Δ
#rusttests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/core/src/cmd.rs
src/core/src/ffi/mod.rs
src/core/src/index/storage.rs
src/core/src/errors.rs
src/core/src/signature.rs
src/core/src/ffi/signature.rs
src/core/src/index/bigsi.rs
src/core/src/sketch/ukhs.rs
src/core/src/sketch/minhash.rs
src/core/tests/test.rs
... and 24 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 55f863e...7b9f67e. Read the comment docs.

README.md Outdated Show resolved Hide resolved
@luizirber
Copy link
Member Author

Before:
image
After:
image

@ctb
Copy link
Contributor

ctb commented Jul 25, 2020

👍

@luizirber luizirber changed the title [WIP] Add sourmash logo to docs and README [MRG] Add sourmash logo to docs and README Jul 26, 2020
@luizirber
Copy link
Member Author

Ready for review and merge @ctb @taylorreiter

Copy link
Contributor

@ctb ctb left a comment

Choose a reason for hiding this comment

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

go for it!

@luizirber luizirber merged commit 1d69e10 into master Jul 26, 2020
@luizirber luizirber deleted the logo branch July 26, 2020 15:55
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.

Design a logo for sourmash
2 participants