Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AverseABFun authored Jan 2, 2025
1 parent 67952ea commit fa7f13e
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
# rust-pkg-gen

WHEN INSTALLING, INSTALL WITH `-Z bindeps`! OTHERWISE IT LIKELY WILL NOT INSTALL!

`rust-pkg-gen` creates so-called rust packages with arbitrary toolchains/components and arbitrary crates. These packages then can be used on separate machines, and installed with provided install scripts.

To use the cli, you can generally simply run `rust-pkg-gen`/`cargo run`. There are a couple of command line options, mostly for debugging, that you can see in `src/main.rs` and below:

Also note that if --path is not set, it assumes `./rust-config.toml`.

| Argument | Purpose |
| -------- | ------- |
| --temp-dir | Changes the temporary directory. Use in conjunction with --save-temp to save more of the temporary files. Some temporary files are always kept. Default value in debug builds is ./test, in release builds a automatically created directory in the system temporary directory. |
Expand Down

0 comments on commit fa7f13e

Please sign in to comment.