Skip to content

Commit ac2c3b2

Browse files
committed
gh: star-history + polish [skip ci]
Signed-off-by: Élie Goudout <elie.goudout@thalesgroup.com>
1 parent e0b1084 commit ac2c3b2

1 file changed

Lines changed: 19 additions & 6 deletions

File tree

README.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,29 +72,42 @@ pip install scio-pypi # The `-pypi` suffix will be removed soon
7272

7373

7474
### Documentation 📖
75-
The full documentation can be found [here][docs]. You may specifically refer to [tutorials], [API references][api] or scientific literature [references].
75+
The full documentation can be found [**here**][docs]. You may learn more [about scio][about], [get started][get_started] and follow [tutorials], or specifically browse [API references][api] and scientific literature [references].
7676

7777
### Citing `scio` 🎓
7878
<!-- START CITING -->
79-
If you find our library useful in your work, please reference it using the following entry (for bibtex).
80-
81-
*Coming soon ...*
79+
If our library contributed to your research or project, please consider citing it. For convenience, we provide the following BibTeX entry.
80+
```BibTeX
81+
Coming soon...
82+
```
8283
<!-- END CITING -->
8384

8485
### Contributing 💫
85-
Questions, [issues], [discussions] and [pull requests][pulls] are welcome! Read our [Contributing Guide](CONTRIBUTING.md) and join our team of [contributors](CONTRIBUTORS.md)
86+
Questions, [issues], [discussions] and [pull requests][pulls] are welcome! Read our [contributing guide](CONTRIBUTING.md) and join our team of [contributors]
8687

8788
For development, we recommend using `uv` since we ship `uv.lock` for better development reproducibility.
8889

90+
### Star history ⭐
91+
<picture>
92+
<source media="(prefers-color-scheme: dark)"
93+
srcset="https://api.star-history.com/svg?repos=ThalesGroup/scio&type=Date&theme=dark" />
94+
<img alt="Star History Chart"
95+
src="https://api.star-history.com/svg?repos=ThalesGroup/scio&type=Date"
96+
title="Help me grow! Feed me a ⭐" />
97+
</picture>
98+
8999
### License ⚖️
90-
This package is distributed under the [MIT license](LICENSE). The use of nvidia proprietary modules (for GPU acceleration) is optional.
100+
This package is distributed under the [MIT license](LICENSE). The use of NVIDIA proprietary modules (for GPU acceleration) is optional.
91101

92102
<!-- References -->
93103
[docs]: https://sciortd.readthedocs.io
104+
[about]: https://sciortd.readthedocs.io/latest/user_guide/what_is_scio.html#what-is-scio
105+
[get_started]: https://sciortd.readthedocs.io/latest/user_guide/installation_compatibility.html#installation-compatibility
94106
[tutorials]: https://sciortd.readthedocs.io/latest/auto_tutorials/index.html
95107
[api]: https://sciortd.readthedocs.io/latest/api_references.html
96108
[references]: https://sciortd.readthedocs.io/latest/bib_references.html
97109
[citing]: https://sciortd.readthedocs.io/latest/citing_scio.html
98110
[issues]: https://github.com/ThalesGroup/scio/issues
99111
[discussions]: https://github.com/ThalesGroup/scio/discussions
100112
[pulls]: https://github.com/ThalesGroup/scio/pulls
113+
[contributors]: https://sciortd.readthedocs.io/latest/contributors.html

0 commit comments

Comments
 (0)