Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed repeated installation instructions #101

Merged
merged 4 commits into from
Aug 14, 2020
Merged

Removed repeated installation instructions #101

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
03bede1
Removed repeated installation instructions
ahcorde Aug 13, 2020
d46429e
Fixed README.md installation link
ahcorde Aug 14, 2020
938d1cf
Improved installation visualization
ahcorde Aug 14, 2020
27a6d70
tweak to README
chapulina Aug 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 1 addition & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,7 @@ Test coverage reports are available at Codecov:

# Building and installing

```
cd ign-fuel-tools
mkdir build
cd build
cmake ..
make
make test
make install
```

Make sure `IGN_CONFIG_PATH` is set to the right install location`ign fuel` will work.
Default is `/usr/local/share/ignition`.
See the [installation tutorial](https://ignitionrobotics.org/api/fuel_tools/4.0/install.html).

## Examples

Expand Down Expand Up @@ -191,4 +180,3 @@ export IGN_CONFIG_PATH=$HOME/.ignition/tools/configs
```

This issue is tracked [here](https://github.com/ignitionrobotics/ign-tools/issues/8).

30 changes: 13 additions & 17 deletions tutorials/01_installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,24 +92,20 @@ cd build

Configure Ignition Fuel Tools (choose either method a or b below):

* A. Release mode: This will generate optimized code, but will not have debug symbols. Use this mode if you don't need to use GDB.

```
cmake ../
```

Note: You can use a custom install path to make it easier to switch
between source and debian installs:

```
cmake -DCMAKE_INSTALL_PREFIX=/home/$USER/local ../
```

* B. Debug mode: This will generate code with debug symbols. Ignition Fuel Tools will run slower, but you'll be able to use GDB.
* **A**. Release mode: This will generate optimized code, but will not have debug symbols. Use this mode if you don't need to use GDB.
```
cmake ../
```
Note: You can use a custom install path to make it easier to switch
between source and debian installs:
```
cmake -DCMAKE_INSTALL_PREFIX=/home/$USER/local ../
```

```
cmake -DCMAKE_BUILD_TYPE=Debug ../
```
* **B**. Debug mode: This will generate code with debug symbols. Ignition Fuel Tools will run slower, but you'll be able to use GDB.
```
cmake -DCMAKE_BUILD_TYPE=Debug ../
```

The output from `cmake ../` may generate a number of errors and warnings
about missing packages. You must install the missing packages that have
Expand Down