Skip to content

Commit

Permalink
Remove references to install command from the tutorial (#1877) (#1928)
Browse files Browse the repository at this point in the history
The tutorial refers to the "install" command in the 'Build Ref
Deployment' section.  However, that command was removed in 20b5f29, a
commit released as early as v2.0.0~193^2.

This commit removes references to the install command from the tutorial.

The mention that the build command also copies the binaries to the bin
dir is moved earlier in the text, simply because it flows better when
the rest of the note about the install command is removed.
  • Loading branch information
ivanperez-keera authored Mar 16, 2023
1 parent 05f1c49 commit e9c2144
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions docs/Tutorials/GettingStarted/Tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -179,23 +179,21 @@ cd fprime/Ref/SignalGen
fprime-util build
```

The user can also build a deployment by navigating to the deployment directory and running the `build` command. This is
shown below:
The user can also build a deployment by navigating to the deployment directory and running the `build` command. The build
command also copies the binary to the deployments "bin" directory, i.e. `fprime/Ref/bin`. This is shown below:

**Build Ref Deployment**
```
cd fprime/Ref
fprime-util build
```
**Note:** the user almost always wants to run the "install" command on deployments. This builds the binary like "build"
but also copies the binary to the deployments "bin" directory, i.e. `fprime/Ref/bin`. Install is described below.

This process also built the Dictionaries for the project and places the dictionary in the "Top" folder of the deployment.
This happens any time the "install" or "build" command are run on a deployment.
This happens any time the "build" command is run on a deployment.

The user can also build a component or deployment for a cross-compile by specifying the toolchain. A previous generate
for that toolchain should have been run. Again for deployments, the user typically should run "install", see below. These
steps require the setup described here: [RPI](https://github.com/nasa/fprime/blob/master/RPI/README.md)
for that toolchain should have been run. These steps require the setup described here:
[RPI](https://github.com/nasa/fprime/blob/master/RPI/README.md)

```
cd fprime/Ref/SignalGen
Expand Down

0 comments on commit e9c2144

Please sign in to comment.