Skip to content

Commit cb968a1

Browse files
committed
Updated readme. Added test runner config.
1 parent c6fba61 commit cb968a1

2 files changed

Lines changed: 30 additions & 2 deletions

File tree

.github/workflows/run-tests.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: tests
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
branches:
7+
- master
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout repository
15+
uses: actions/checkout@v4
16+
17+
- name: Set up Python
18+
uses: actions/setup-python@v5
19+
with:
20+
python-version: '3.11'
21+
cache: 'pip'
22+
23+
- name: Install dependencies
24+
run: |
25+
pip install .[dev]
26+
27+
- name: Run tests
28+
run: |
29+
pytest

readme.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ This module provides easy access to the database in python.
66

77
## Install
88

9-
Clone and cd into `acorg/acorgdb` then `pip install .` (`pip install -e .[dev]`
10-
if you want to make changes.)
9+
`pip install acorgdb`
1110

1211
## Example usage
1312

0 commit comments

Comments
 (0)