Skip to content

Commit 1fd89a0

Browse files
authored
docs(readme): update installation instructions and badges (#299)
* docs(readme): update installation instructions * docs(docs): update installation instructions * ci(github): update CI job name
1 parent 93bb3fe commit 1fd89a0

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

.github/workflows/page-build.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: GH-Pages Status
1+
name: page-build
22
on:
33
page_build
44

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
</h1>
44

55
<p align="center">
6-
<a href="https://github.com/frgfm/torch-cam/actions/workflows/builds.yml">
7-
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/builds.yml?branch=main&label=CI&logo=github&style=flat-square">
6+
<a href="https://github.com/frgfm/torch-cam/actions/workflows/build.yml">
7+
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/build.yml?branch=main&label=CI&logo=github&style=flat-square">
88
</a>
99
<a href="https://github.com/astral-sh/ruff">
1010
<img src="https://img.shields.io/badge/Linter-Ruff-FCC21B?style=flat-square&logo=ruff&logoColor=white" alt="ruff">
@@ -39,7 +39,7 @@
3939
</p>
4040
<p align="center">
4141
<a href="https://frgfm.github.io/torch-cam">
42-
<img src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/docs.yaml?branch=main&label=Documentation&logo=read-the-docs&logoColor=white&style=flat-square" alt="Documentation Status">
42+
<img src="https://img.shields.io/github/actions/workflow/status/frgfm/torch-cam/page-build.yml?branch=main&label=Documentation&logo=read-the-docs&logoColor=white&style=flat-square" alt="Documentation Status">
4343
</a>
4444
</p>
4545

@@ -125,7 +125,7 @@ plt.imshow(result); plt.axis('off'); plt.tight_layout(); plt.show()
125125

126126
## Setup
127127

128-
Python 3.8 (or higher) and [pip](https://pip.pypa.io/en/stable/)/[conda](https://docs.conda.io/en/latest/miniconda.html) are required to install TorchCAM.
128+
Python 3.9 (or higher) and [uv](https://docs.astral.sh/uv/)/[conda](https://docs.conda.io/en/latest/miniconda.html) are required to install TorchCAM.
129129

130130
### Stable release
131131

docs/source/installing.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
Installation
44
************
55

6-
This library requires `Python <https://www.python.org/downloads/>`_ 3.8 or higher.
6+
This library requires `Python <https://www.python.org/downloads/>`_ 3.9 or higher.
77

88
Via Python Package
99
==================
1010

11-
Install the last stable release of the package using `pip <https://pip.pypa.io/en/stable/installation/>`_:
11+
Install the last stable release of the package using `uv <https://docs.astral.sh/uv/>`_:
1212

1313
.. code:: bash
1414
15-
pip install torchcam
15+
uv pip install torchcam
1616
1717
1818
Via Conda
@@ -33,4 +33,4 @@ Install the library in developer mode:
3333
.. code:: bash
3434
3535
git clone https://github.com/frgfm/torch-cam.git
36-
pip install -e torch-cam/.
36+
uv pip install -e torch-cam/.

0 commit comments

Comments
 (0)