Skip to content

Commit 12a8f52

Browse files
committed
separated x32 and x64 release streams, preparing for release 0.1.1
1 parent 52dc7ae commit 12a8f52

2 files changed

Lines changed: 20 additions & 6 deletions

File tree

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33

44
## Installation
55

6-
Download the latest release binary file from the Releases section in the sidebar. You probably want the `.whl` file. You can place this file anywhere, but I would recommend placing it in a `Plugins` folder inside your Hilltop installation, for example `C:\Hilltop\Plugins\`
6+
### Download the Plugin files
7+
8+
Download the latest release binary file from the Releases section in the sidebar. You probably want the `.whl` files. It is likely that you would need to install both the 32 and 64 bit versions of the plugin. You can place this file anywhere, but I would recommend placing it in a `Plugins` folder inside your Hilltop installation, for example `C:\Hilltop\Plugins\`
79

810
Open your Hilltop directory in a terminal emulator. You can do this by navigating to the directory in File Explorer, right-clicking in white space and hitting "Open in Terminal". (In Windows 11 you might have to hit "More options" or something to bring up to bring up the Windows 10 menu for some reason.)
911

@@ -24,11 +26,11 @@ where `<path>` is the relative path to the plugin `.whl` or `.tar.gz` file that
2426
For example, if your Hilltop directory is `C:\Hilltop` and you've saved your plugin file in `C:\Hilltop\Plugins`, then your command line would look like this:
2527

2628
```
27-
PS C:\Hilltop> .\Libs\python.exe -m pip install .\Plugins\samplerqrgenerator-0.1.0_win32.whl
29+
PS C:\Hilltop> .\Libs\python.exe -m pip install .\Plugins\samplerqrgenerator-0.1.1.whl
2830
```
2931
for 32 bit, or
3032
```
31-
PS C:\Hilltop> .\x64\Libs\python.exe -m pip install .\Plugins\samplerqrgenerator-0.1.0_win64.whl
33+
PS C:\Hilltop> .\x64\Libs\python.exe -m pip install .\Plugins\samplerqrgenerator-0.1.1.whl
3234
```
3335
for the 64 bit version.
3436

@@ -39,4 +41,18 @@ Finally you need to specify the directory to which the plugin with save the qr c
3941
LabelOutputDir = \\directory\for\qr\code\output
4042
```
4143

44+
# Build instructions
45+
46+
This section is for developers who want to build the source binaries for release.
47+
48+
Due to the two supported architectures, we need to make separate releases for 32 and 64-bit architectures. Unfortunately this information cannot be passed as "platform" specifications as this will block installation of the wheel on a machine that doesn't have a CPU architecture that agrees with the Hilltop architecture.
49+
50+
For that reason we can specify the Hilltop architecture as a `build-number`, which is just a suffix to the version number used to differentiate different builds of the same version. This can be passed to the build backend with the following build command:
51+
52+
```
53+
../../x64/Libs/python.exe -m build -w -C="--build-option=--build-number 64bit --python-tag py310" -n .
54+
```
55+
56+
We'll use the convention that a build number of `32bit` is a plugin intended for the 32 bit Hilltop, and build number `64bit` is for 64 bit Hilltop.
4257

58+
Note that the above command also specifies the python version. This is just a failsafe that might prevent installations of the plugins using other python interpreters installed on the user's system.

pyproject.toml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@ build-backend = "setuptools.build_meta"
55
[project]
66
requires-python = ">= 3.10.11"
77
name = "samplerqrgenerator"
8-
version = "0.1.0"
8+
version = "v0.1.1"
99
dependencies = [
1010
"qrcode",
1111
"Pillow",
1212
]
1313

1414
[project.entry-points.'hilltop.preregistration']
1515
"QRGenerator" = 'samplerqrgenerator:QRGenerator'
16-
17-

0 commit comments

Comments
 (0)