Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
colganwi committed May 10, 2024
1 parent 18e6a9f commit 75b58d0
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -65,3 +65,5 @@ jobs:
coverage report
- name: Upload coverage
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# pycea

[![Tests][badge-tests]][link-tests]
[![Documentation][badge-docs]][link-docs]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/colganwi/pycea/test.yaml?branch=main
[link-tests]: https://github.com/YosefLab/pycea/actions/workflows/test.yml
[badge-docs]: https://img.shields.io/readthedocs/pycea

Scverse lineage tracing toolkit
<img
src="https://raw.githubusercontent.com/YosefLab/pycea/main/docs/_static/img/pycea_logo.svg"
class="dark-light" align="right" width="350" alt="image"
/>

## Getting started
# Pycea - lineage tracing analysis

Please refer to the [documentation][link-docs]. In particular, the
Scverse lineage tracing analysis toolkit built to work with [TreeData][treedata].

- [API documentation][link-api].
To learn more about pycea, please refer to the [documentation][link-docs] or the [getting started guide][link-getting-started].

## Installation

Expand Down Expand Up @@ -42,15 +43,16 @@ See the [changelog][changelog].

## Contact

For questions and help requests, you can reach out in the [scverse discourse][scverse-discourse].
If you found a bug, please use the [issue tracker][issue-tracker].
For questions and bug reports please use the [issue tracker][issue-tracker].

## Citation

> t.b.a
[treedata]: https://treedata.readthedocs.io/
[scverse-discourse]: https://discourse.scverse.org/
[issue-tracker]: https://github.com/colganwi/pycea/issues
[changelog]: https://pycea.readthedocs.io/latest/changelog.html
[link-docs]: https://pycea.readthedocs.io
[link-api]: https://pycea.readthedocs.io/latest/api.html
[link-getting-started]: https:/pycea.readthedocs.io/en/latest/notebooks/getting-started.html
58 changes: 58 additions & 0 deletions docs/_static/img/pycea_logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,8 @@
"navigation_with_keys": False,
}

html_logo = "_static/img/pycea_logo.svg"

pygments_style = "default"

nitpick_ignore = [
Expand Down

0 comments on commit 75b58d0

Please sign in to comment.