From 814cbce4cc369495af9c9844a0a7cf5159ac2f28 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Thu, 25 Aug 2022 11:07:55 +0200 Subject: [PATCH 1/3] Adjust link text --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a66a7e060..dcb1d52d2 100644 --- a/README.md +++ b/README.md @@ -118,7 +118,7 @@ Since Fornjot uses Rust as the language for defining models, a [Rust toolchain]( To install Fornjot itself, you have the following options: -1. Download a binary from [the latest release](https://github.com/hannobraun/Fornjot/releases). +1. Download a binary from the [latest release](https://github.com/hannobraun/Fornjot/releases). 2. Compile the latest release yourself: `cargo install fj-app` 3. Compile a development version from this repository: `cd path/to/repo; cargo install --path crates/fj-app` From a42e1d2f0d93cf58b897cde74ea87e45429ac540 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Thu, 25 Aug 2022 11:08:54 +0200 Subject: [PATCH 2/3] Change `fj` link to `crates.io` --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index dcb1d52d2..6800d3163 100644 --- a/README.md +++ b/README.md @@ -126,7 +126,7 @@ While the Fornjot application is a graphical application that opens a window and ### Defining models -Models are Rust libraries that depend on the [`fj`](crates/fj) library, which they use to define the geometry. Furthermore, they need to be built as a dynamic library. Just use the examples in the [`models/`](models) directory as a template to define your own. +Models are Rust libraries that depend on the [`fj`](https://crates.io/crates/fj) library, which they use to define the geometry. Furthermore, they need to be built as a dynamic library. Just use the examples in the [`models/`](models) directory as a template to define your own. ### Viewing models From 41dc89a454dda14e0e10bd1f8d36692d8e7d5f89 Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Thu, 25 Aug 2022 11:11:18 +0200 Subject: [PATCH 3/3] Clarify documentation on viewing models --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 6800d3163..c1aea2b09 100644 --- a/README.md +++ b/README.md @@ -136,7 +136,7 @@ To view a model, run: fj-app --model my-model ``` -This will compile and load the model in the `my-model/` directory. +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). Rotate the model by pressing the left mouse button while moving the mouse. Move the model by pressing the right mouse button while moving the mouse. Zoom with the mouse wheel.