Skip to content

Commit e625fb6

Browse files
committed
copy edits
1 parent e517765 commit e625fb6

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

docs/project-contributions.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,29 +2,34 @@
22

33
The information in this page is primarily for those who wish to contribute to the c2pa-python library project itself, rather than those who simply wish to use it in an application. For general contribution guidelines, see [CONTRIBUTING.md](../CONTRIBUTING.md).
44

5-
## Development Setup
5+
## Setup
66

77
It is best to [set up a virtual environment](https://virtualenv.pypa.io/en/latest/installation.html) for development and testing:
88

99
```bash
1010
# Create virtual environment
1111
python -m venv .venv
12-
13-
# Activate virtual environment
14-
# On Windows:
15-
.venv\Scripts\activate
16-
# On macOS/Linux:
17-
source .venv/bin/activate
1812
```
1913

14+
Activate the virtual environment.
15+
16+
- On Windows:
17+
```bash
18+
.venv\Scripts\activate
19+
```
20+
- On macOS/Linux:
21+
```bash
22+
source .venv/bin/activate
23+
```
24+
2025
Load project dependencies:
2126

2227
```bash
2328
pip install -r requirements.txt
2429
pip install -r requirements-dev.txt
2530
```
2631

27-
Download library artifacts for the current version you want, eg v0.55.0:
32+
Download library artifacts for the current version you want, (for example, as shown below for v0.55.0):
2833

2934
```bash
3035
python scripts/download_artifacts.py c2pa-v0.55.0
@@ -36,10 +41,10 @@ Install the package in development mode:
3641
pip install -e .
3742
```
3843

39-
This will:
44+
This command:
4045

41-
- Copy the appropriate libraries for your platform from `artifacts/` to `src/c2pa/libs/`
42-
- Install the package in development mode, allowing you to make changes to the Python code without reinstalling.
46+
- Copies the appropriate libraries for your platform from `artifacts/` to `src/c2pa/libs/`
47+
- Installs the package in development mode, so you can make changes to the Python code without reinstalling.
4348

4449
## Build from source
4550

@@ -130,10 +135,10 @@ Run tests by following these steps:
130135
make test
131136
```
132137
5. Alternatively, install pytest (if not already installed) and run it:
133-
```bash
134-
pip install pytest
135-
pytest
136-
```
138+
```bash
139+
pip install pytest
140+
pytest
141+
```
137142

138143
### Testing during bindings development
139144

0 commit comments

Comments
 (0)