Skip to content

Commit c7d4c32

Browse files
authored
Update build documentation (#12)
1 parent 0e63116 commit c7d4c32

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ For a more streamlined workflow, consider using the built-in [app](https://hatch
1616
**Table of Contents**
1717

1818
- [Building](#building)
19+
- [Installation](#installation)
20+
- [Local repository](#local-repository)
1921
- [Runtime behavior](#runtime-behavior)
2022
- [Initialization](#initialization)
2123
- [Detection](#detection)
@@ -48,14 +50,32 @@ For a more streamlined workflow, consider using the built-in [app](https://hatch
4850

4951
## Building
5052

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:
5260

5361
```
5462
cargo install pyapp --force --root <DIR>
5563
```
5664

5765
The executable will be located at `<DIR>/bin/pyapp.exe` if on Windows or `<DIR>/bin/pyapp` otherwise.
5866

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.
78+
5979
## Runtime behavior
6080

6181
### Initialization

0 commit comments

Comments
 (0)