Skip to content

Commit 7e3dded

Browse files
committed
Update README about Git LFS requirement
1 parent 0906e48 commit 7e3dded

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,31 @@ The system consists of 4 components:
3030
1. [Docker](https://www.docker.com/get-started)
3131
2. [Python 3.9+](https://www.python.org/downloads)
3232
3. [OpenSSL 1.1 for CBS Python SDK](https://docs.couchbase.com/python-sdk/current/hello-world/start-using-sdk.html)
33+
4. [Git LFS](https://git-lfs.com)
3334

3435
### Steps
3536

36-
1. Open a terminal window and start the environment by running the `./start_environment.py` script in the environment folder.
37+
1. Clone the repository.
38+
```
39+
$ git clone https://github.com/couchbaselabs/couchbase-lite-tests.git
40+
```
41+
This repository uses Git LFS to store binary dataset files. Ensure that you have [Git LFS](https://git-lfs.com) installed, and run `git lfs install` once to setup the extension hook before cloning the repository.
42+
43+
2. Open a terminal window and start the environment by running the `./start_environment.py` script in the environment folder.
3744
The script will start CBS and SG in the docker container in the background and wait until SG is successfully started before exiting.
3845
```
3946
cd environment
4047
./start_environment.py
4148
```
4249
* To shutdown the environment, run `docker compose down`.
4350

44-
2. Build and run the test server of the platform that you want to test.
51+
3. Build and run the test server of the platform that you want to test.
4552
* [C](https://github.com/couchbaselabs/couchbase-lite-tests/tree/main/servers/c)
4653
* Android
4754
* .Net
4855
* iOS
4956

50-
3. From the tests directory, set up a python virtual environment:
57+
4. From the tests directory, set up a python virtual environment:
5158
```
5259
cd tests
5360
python3 -m venv venv
@@ -58,11 +65,11 @@ The system consists of 4 components:
5865
* You only need to create the python venv once. To reactivate run `. venv/bin/activate`, and to deactivate run `deactivate`.
5966
* When you update the repo or the Python TDK code, run `pip install ../client` to update the TDK.
6067

61-
4. Edit the file `config.example.json` with the URL of your Test server started in the Step 2.
68+
5. Edit the file `config.example.json` with the URL of your Test server started in the Step 2.
6269
```
6370
"test-servers": ["http://192.168.100.104:8080"]
6471
```
65-
5. Run the pytest tests as examples below.
72+
6. Run the pytest tests as examples below.
6673
```
6774
# Run one test file:
6875
pytest --config config.example.json test_basic_replication.py

0 commit comments

Comments
 (0)