mirror of https://github.com/hannobraun/Fornjot
remove the "--model" option from CLI examples in docs
This commit is contained in:
parent
d162361fb0
commit
0f65994668
|
@ -108,7 +108,7 @@ Models are Rust libraries that depend on the [`fj`](https://crates.io/crates/fj)
|
||||||
To view a model, run:
|
To view a model, run:
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
fj-app --model my-model
|
fj-app my-model
|
||||||
```
|
```
|
||||||
|
|
||||||
This will usually compile and load the model in the `my-model/` directory. If there is a configuration file (`fj.toml`) available, it might define a default path to load models from that is different from the current working directory. This is the case [in the Fornjot repository](fj.toml).
|
This will usually compile and load the model in the `my-model/` directory. If there is a configuration file (`fj.toml`) available, it might define a default path to load models from that is different from the current working directory. This is the case [in the Fornjot repository](fj.toml).
|
||||||
|
@ -122,7 +122,7 @@ Toggle model rendering by pressing `1`. Toggle mesh rendering by pressing `2`. T
|
||||||
To export a model to a file, run:
|
To export a model to a file, run:
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
fj-app --model my-model --export my-model.3mf
|
fj-app my-model --export my-model.3mf
|
||||||
```
|
```
|
||||||
|
|
||||||
The file type is chosen based on the file extension. Both 3MF and STL are supported.
|
The file type is chosen based on the file extension. Both 3MF and STL are supported.
|
||||||
|
@ -132,7 +132,7 @@ The file type is chosen based on the file extension. Both 3MF and STL are suppor
|
||||||
Models can define parameters that can be overridden. This can be done using the `--parameters` argument:
|
Models can define parameters that can be overridden. This can be done using the `--parameters` argument:
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
fj-app --model my-model --parameters "width=3.0,height=5.0"
|
fj-app my-model --parameters "width=3.0,height=5.0"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
6
fj.toml
6
fj.toml
|
@ -1,9 +1,9 @@
|
||||||
# The default path that models are loaded from. If the `--model` argument is a
|
# The default path that models are loaded from. If the `model` argument is a
|
||||||
# relative path, it is assumed to be relative to `default_path`.
|
# relative path, it is assumed to be relative to `default_path`.
|
||||||
default_path = "models"
|
default_path = "models"
|
||||||
|
|
||||||
# The default models that is loaded, if none is specified. If this is a relative
|
# The default models that is loaded, if none is specified in a CLI.
|
||||||
# path, it should be relative to `default_path`.
|
# If this is a relative path, it should be relative to `default_path`.
|
||||||
default_model = "test"
|
default_model = "test"
|
||||||
|
|
||||||
# Indicate whether to invert the zoom direction. Can be used to override the
|
# Indicate whether to invert the zoom direction. Can be used to override the
|
||||||
|
|
|
@ -4,7 +4,7 @@ A model of a simple cuboid that demonstrates sweeping a 3D shape from a primitiv
|
||||||
|
|
||||||
To display this model, run the following from the repository root (model parameters are optional):
|
To display this model, run the following from the repository root (model parameters are optional):
|
||||||
``` sh
|
``` sh
|
||||||
cargo run -- --model cuboid --parameters x=3.0,y=2.0,z=1.0
|
cargo run -- cuboid --parameters x=3.0,y=2.0,z=1.0
|
||||||
```
|
```
|
||||||
|
|
||||||
![Screenshot of the cuboid model](cuboid.png)
|
![Screenshot of the cuboid model](cuboid.png)
|
||||||
|
|
|
@ -4,7 +4,7 @@ A simple spacer model that demonstrates the circle primitive, the difference ope
|
||||||
|
|
||||||
To display this model, run the following from the repository root (model parameters are optional):
|
To display this model, run the following from the repository root (model parameters are optional):
|
||||||
``` sh
|
``` sh
|
||||||
cargo run -- --model spacer --parameters outer=1.0,inner=0.5,height=1.0
|
cargo run -- spacer --parameters outer=1.0,inner=0.5,height=1.0
|
||||||
```
|
```
|
||||||
|
|
||||||
![Screenshot of the spacer model](spacer.png)
|
![Screenshot of the spacer model](spacer.png)
|
||||||
|
|
|
@ -4,7 +4,7 @@ A model of a star that demonstrates sweeping a sketch to create a 3D shape, conc
|
||||||
|
|
||||||
To display this model, run the following from the repository root (model parameters are optional):
|
To display this model, run the following from the repository root (model parameters are optional):
|
||||||
``` sh
|
``` sh
|
||||||
cargo run -- --model star --parameters num_points=5,r1=1.0,r2=2.0,h=1.0
|
cargo run -- star --parameters num_points=5,r1=1.0,r2=2.0,h=1.0
|
||||||
```
|
```
|
||||||
|
|
||||||
![Screenshot of the star model](star.png)
|
![Screenshot of the star model](star.png)
|
||||||
|
|
|
@ -4,7 +4,7 @@ A model that tries to use all of Fornjot's features, to serve as a testing groun
|
||||||
|
|
||||||
To display this model, run the following from the repository root:
|
To display this model, run the following from the repository root:
|
||||||
``` sh
|
``` sh
|
||||||
cargo run -- --model test
|
cargo run -- test
|
||||||
```
|
```
|
||||||
|
|
||||||
![Screenshot of the test model](test.png)
|
![Screenshot of the test model](test.png)
|
||||||
|
|
Loading…
Reference in New Issue