Skip to content

Commit 8b95bc2

Browse files
committed
Updated readme further with install instructions. Fixed packaging issues where archives were not being included in final builds.
1 parent f8692a1 commit 8b95bc2

File tree

2 files changed

+30
-2
lines changed

2 files changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,36 @@ a level of maturity similar to WmlComparer. At the moment it is NOT included.
5353

5454
## Getting started
5555

56+
### Install .NET Core 8
57+
58+
The Open-XML-PowerTools engine we're using in the initial releases requires .NET to run (don't worry, this is very
59+
well-supported cross-platform at the moment). Our builds are targeting x86-64 Linux and Windows, however, so you'll
60+
need to modify the build script and build new binaries if you want to target another runtime / architecture.
61+
62+
#### On Linux
63+
64+
You can follow [Microsoft's instructions for your Linux distribution](https://learn.microsoft.com/en-us/dotnet/core/install/linux)
65+
66+
#### On Windows
67+
68+
You can follow [Microsoft's instructions for your Windows vesrion](https://learn.microsoft.com/en-us/dotnet/core/install/windows?tabs=net80)
69+
70+
### Install the Library
71+
72+
At the moment, we are not distributing via pypi. You can easily install directly from this repo, however.
73+
74+
```commandline
75+
pip install git+https://github.com/JSv4/Python-Docx-Redlines
76+
```
77+
78+
You can add this as a dependency like so
79+
80+
```requirements
81+
python_redlines @ git+https://github.com/JSv4/Python-Docx-Redlines@v.0.0.1
82+
```
83+
84+
### Use the Library
85+
5686
If you just want to use the tool, jump into our [quickstart guide](docs/quickstart.md).
5787

5888
## Architecture Overview

pyproject.toml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ build-backend = "hatchling.build"
44

55
[tool.hatch.build.targets.wheel.force-include]
66
"dist" = "python_redlines/dist"
7-
#"dist/linux-x64-0.0.1.tar.gz" = "python_redlines/dist/linux-x64-0.0.1.tar.gz"
8-
#"dist/win-x64-0.0.1.zip" = "python_redlines/dist/win-x64-0.0.1.zip"
97

108
[tool.hatch.build.targets.wheel]
119
artifacts = [

0 commit comments

Comments
 (0)