Skip to content

Commit

Permalink
remove $ from sh scripts
Browse files Browse the repository at this point in the history
  • Loading branch information
devleaks committed Aug 24, 2024
1 parent a2a276c commit 4dcd018
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/Installation and Usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@ In particular, the X-Plane Cockpitdecks Helper plugin uses and requires the late
Create a new python environment and activate it. In that environment, issue the pip install command:

```sh
$ pip install git+https://github.com/devleaks/cockpitdecks.git
pip install git+https://github.com/devleaks/cockpitdecks.git
```

### Install Additional Optional Python Packages

If you would like to use Weather or METAR buttons, add the following packages:

```
$ pip install avwx-engine scipy suntime timezonefinder metar tabulate
pip install avwx-engine scipy suntime timezonefinder metar tabulate
```

### Install Deck Devices Drivers
Expand All @@ -65,19 +65,19 @@ $ pip install avwx-engine scipy suntime timezonefinder metar tabulate
To have Cockpitdecks manage Streamdeck devices, add

```shell
$ pip install streamdeck
pip install streamdeck
```

To have Cockpitdecks manage Loupedeck devices, add

```shell
$ pip install git+https://github.com/devleaks/python-loupedeck-live.git
pip install git+https://github.com/devleaks/python-loupedeck-live.git
```

To have Cockpitdecks manage Touch Mini devices, add

```shell
$ pip install git+https://github.com/devleaks/python-berhinger-xtouchmini.git
pip install git+https://github.com/devleaks/python-berhinger-xtouchmini.git
```

### Install Cockpitdecks Helper Plugin
Expand Down Expand Up @@ -185,7 +185,7 @@ without any argument:
A second easy step is to start Cockpitdecks in demonstration mode. In this mode, it will offer a single demonstration deck. See [[Examples]] for details about the demonstration.

```sh
$ cockpitdecks-cli --demo
cockpitdecks-cli --demo
```

In this mode, Cockpitdecks will start a single web deck.
Expand All @@ -208,7 +208,7 @@ This is the simplest case. In this mode, everything is automatic.
Make sure the configuration file is setup and issue:

```sh
$ cockpitdecks-cli
cockpitdecks-cli
```

Cockpitdecks will immediately start in demonstration mode and listen for X-Plane interaction. If Cockpitdecks finds that an aircraft is loaded and that Cockpitdecks `deckconfig` folder exists in the folder of that aircraft, Cockpitdecks will load this configuration.
Expand All @@ -222,7 +222,7 @@ This mode is fully automatic, Cockpitdecks always attempts to load the current a
In this case, it is not possible for Cockpitdecks to locate aircraft configuration files. A set of configuration file will need to be supplied to Cockpitdecks on the command line to start with. (If no folder is supplied, Cockpitdecks will start in demonstration mode. See above.)

```sh
$ cockpitdecks-cli aircrafts/A21N fixed
cockpitdecks-cli aircrafts/A21N fixed
```

Cockpitdecks will start and load the configuration in `aircrafts/A21N/deckcockpit`. Cockpitdecks will attempt to connect to X-Plane.
Expand Down Expand Up @@ -256,7 +256,7 @@ If Cockpitdecks fails to connect to X-Plane or notices it does no longer receive
If you cloned Cockpitdecks software in a folder, you can start Cockpitdecks with

```shell
$ python start.py
python start.py
```

from the top folder of the source code.
Expand Down
Binary file added docs/images/web deck encoders.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4dcd018

Please sign in to comment.