You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-1Lines changed: 21 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,8 @@ For a more streamlined workflow, consider using the built-in [app](https://hatch
16
16
**Table of Contents**
17
17
18
18
-[Building](#building)
19
+
-[Installation](#installation)
20
+
-[Local repository](#local-repository)
19
21
-[Runtime behavior](#runtime-behavior)
20
22
-[Initialization](#initialization)
21
23
-[Detection](#detection)
@@ -48,14 +50,32 @@ For a more streamlined workflow, consider using the built-in [app](https://hatch
48
50
49
51
## Building
50
52
51
-
First configure your [project](#project), then select the directory in which to build the executable with the `--root` option and run:
53
+
Before building your application, you must [configure](#configuration) your [project](#project) at the very least.
54
+
55
+
After you have done that, there are 2 ways to build your application.
56
+
57
+
### Installation
58
+
59
+
Select the directory in which to build the executable with the `--root` option and run:
52
60
53
61
```
54
62
cargo install pyapp --force --root <DIR>
55
63
```
56
64
57
65
The executable will be located at `<DIR>/bin/pyapp.exe` if on Windows or `<DIR>/bin/pyapp` otherwise.
58
66
67
+
### Local repository
68
+
69
+
Clone this repository then enter the cloned directory and run:
70
+
71
+
```
72
+
cargo build --release
73
+
```
74
+
75
+
The executable will be located at `target/release/pyapp.exe` if on Windows or `target/release/pyapp` otherwise. If a particular [target](https://doc.rust-lang.org/cargo/reference/config.html#buildtarget) has been set then the `release` directory will be nested one level deeper under `target/<TARGET>`.
76
+
77
+
***Note:*** If you want to cross compile using [cross](https://github.com/cross-rs/cross), there is currently a [limitation](https://github.com/cross-rs/cross/issues/1215) that requires this method of building.
0 commit comments