Skip to content

Commit 9bae52f

Browse files
authored
Merge pull request #11 from ARPAHLS/feature/cicd-pipeline
docs: Update installation instructions for PyPI release
2 parents 3d30025 + 95e24e9 commit 9bae52f

2 files changed

Lines changed: 11 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<div align="center">
1010
<img src="https://img.shields.io/badge/License-MIT-efcefa?style=flat-square" alt="License">
1111
<img src="https://img.shields.io/badge/Python-3.11+-bae6fd?style=flat-square" alt="Python Version">
12-
<img src="https://img.shields.io/badge/PyPI-v0.1.0-bbf7d0?style=flat-square" alt="PyPI Version">
12+
<a href="https://pypi.org/project/skillware/"><img src="https://img.shields.io/pypi/v/skillware?style=flat-square&color=bbf7d0" alt="PyPI Version"></a>
1313
</div>
1414

1515
<br/>
@@ -86,10 +86,10 @@ Skillware/
8686

8787
### 1. Installation
8888

89-
You can install Skillware directly from GitHub:
89+
You can install Skillware directly from PyPI:
9090

9191
```bash
92-
pip install git+https://github.com/arpahls/skillware.git
92+
pip install skillware
9393
```
9494

9595
Or for development, clone the repository and install in editable mode:

docs/TESTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Skillware maintains high standards for code quality and reliability. Before submitting a Pull Request, please ensure your code passes all linting and testing checks.
44

5+
## Quick Setup
6+
7+
Install all testing and linting dependencies in one go:
8+
9+
```bash
10+
pip install -e .[dev]
11+
```
12+
513
## 1. Code Formatting (Black)
614

715
We use **Black** as our uncompromising code formatter. It ensures that all code looks the same, regardless of who wrote it, eliminating discussions about style.

0 commit comments

Comments
 (0)