Skip to content

docs: Update installation instructions for PyPI release #11

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.

Sign up for GitHub

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

Merged
rosspeili merged 1 commit into from
Feb 15, 2026
Merged

docs: Update installation instructions for PyPI release #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<div align="center">
<img src="https://img.shields.io/badge/License-MIT-efcefa?style=flat-square" alt="License">
<img src="https://img.shields.io/badge/Python-3.11+-bae6fd?style=flat-square" alt="Python Version">
<img src="https://img.shields.io/badge/PyPI-v0.1.0-bbf7d0?style=flat-square" alt="PyPI Version">
<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>
</div>

<br/>
Expand Down Expand Up @@ -86,10 +86,10 @@ Skillware/

### 1. Installation

You can install Skillware directly from GitHub:
You can install Skillware directly from PyPI:

```bash
pip install git+https://github.com/arpahls/skillware.git
pip install skillware
```

Or for development, clone the repository and install in editable mode:
Expand Down
8 changes: 8 additions & 0 deletions docs/TESTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

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

## Quick Setup

Install all testing and linting dependencies in one go:

```bash
pip install -e .[dev]
```

## 1. Code Formatting (Black)

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.
Expand Down
Loading