Skip to content

Commit 730ce50

Browse files
committed
Update docs.
1 parent 612a74c commit 730ce50

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

docs/developer-guide.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,15 @@
1010

1111
### Step 1: Clone the Repository
1212

13-
Clone the RedlinesWrapper repository to your local
13+
Clone the Python-Docx-Redlines repository to your local
1414

1515
machine. Use Git to clone the repository using the following command:
1616

1717
```bash
18-
git clone [URL_OF_YOUR_REPOSITORY]
19-
cd [REPOSITORY_NAME]
18+
git clone https://github.com/JSv4/Python-Docx-Redlines
19+
cd python-docx-redlines
2020
```
2121

22-
Replace `[URL_OF_YOUR_REPOSITORY]` with the actual URL of your repository and `[REPOSITORY_NAME]` with the name of the directory where your repository is cloned.
23-
2422
### Step 2: Install Hatch
2523

2624
If Hatch is not already installed, install it using pip:
@@ -107,8 +105,4 @@ This will run all the test cases defined in your test files.
107105

108106
## Conclusion
109107

110-
You've now set up the RedlinesWrapper project, built the necessary C# binaries, and learned how to use the Python wrapper to compare `.docx` files. Running the tests ensures that your setup is correct and the wrapper functions as expected.
111-
112-
---
113-
114-
Feel free to modify this Quickstart Guide to better fit the specifics of your project, such as the exact commands for building the C# binaries or the directory structure of your project. This guide provides a general framework to get users started with the RedlinesWrapper.
108+
You've now set up the Python-Docx-Redlines project, built the necessary C# binaries, and learned how to use the Python wrapper to compare `.docx` files. Running the tests ensures that your setup is correct and the wrapper functions as expected.

0 commit comments

Comments
 (0)