Skip to content

Commit f675b9c

Browse files
committed
freeze: Add some readmes
[ci skip]
1 parent 4209d03 commit f675b9c

File tree

4 files changed

+51
-2
lines changed

4 files changed

+51
-2
lines changed

MANIFEST.in

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ recursive-include test runner.py README.md
1919

2020
# Binary generators
2121
include freezer/README.md
22-
include freezer/cx_freeze/debian.patch freezer/cx_freeze/Makefile freezer/cx_freeze/windows_msi.sh
23-
include freezer/pyinstaller/hooks/*.py freezer/pyinstaller/runner.py
22+
include freezer/cx_freeze/README.md freezer/cx_freeze/debian.patch freezer/cx_freeze/Makefile freezer/cx_freeze/windows_msi.sh
23+
include freezer/pyinstaller/README.md freezer/pyinstaller/hooks/*.py freezer/pyinstaller/runner.py
2424

freezer/README.md

+11
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,14 @@ Scripts for building binary executables.
55

66
These scripts are not complete and are experimental. Feel free to fix them up so we have reliable builds for those who want them.
77

8+
9+
cx_freeze
10+
---------
11+
12+
cx_freeze puts binaries into a directory. It is not actively maintained. Building with this target may be removed in the future.
13+
14+
15+
pyinstaller
16+
-----------
17+
18+
PyInstaller is more actively maintained and also supports producing a single stand-alone binary. Work should be preferred for this target.

freezer/cx_freeze/README.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
cx_freeze
2+
=========
3+
4+
Currently, scripts exist for Debian and Windows.
5+
6+
7+
Quick Start
8+
===========
9+
10+
Debian
11+
-------
12+
13+
1. Run `Makefile packages/cx_Freeze` to install cx_freeze
14+
2. Run `pip3 install -r requirements.txt`
15+
3. Run `Makefile debian`
16+
17+
18+
Windows
19+
-------
20+
21+
1. Install cx_freeze and lxml using the Windows installers.
22+
2. Run `pip.exe install -r requirements.txt`
23+
3. Run `windows_msi.sh`
24+

freezer/pyinstaller/README.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
pyinstaller
2+
===========
3+
4+
The `runner.py` script is designed to install dependencies into a virtualenv.
5+
6+
It currently only works in Debian/Ubuntu.
7+
8+
9+
Quick Start
10+
===========
11+
12+
1. Install virtualenv.
13+
2. Run the script. Use something like `python3 runner.py`. It will download pyinstaller and all of Wpull's dependencies.
14+

0 commit comments

Comments
 (0)