Skip to content

Commit

Permalink
added .keys
Browse files Browse the repository at this point in the history
  • Loading branch information
devleaks committed Jul 11, 2024
1 parent d60c8b7 commit 731c78e
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 8 deletions.
8 changes: 4 additions & 4 deletions docs/Extending/Internals/Workflow for Web Deck Design.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Here is a suggested workflow for web deck design.

Ideally, X-Plane simulator should be running to get live response data.

Get a background image. PNG or JPEG only.
Get a background image. `PNG` or `JPEG` only.

Place it in

Expand All @@ -15,7 +15,7 @@ Place it in
Start cockpitdecks for that aircraft:

```sh
$ python bon/cockpitdecks_start.py <Aircraft>
$ cockpitdecks-cli <Aircraft>
```

Cockpitdecks will start the application server, notice the available background image and Deck Designer will be available.
Expand Down Expand Up @@ -87,7 +87,7 @@ From now on, it is now possible to adjust any of the layout, or button definitio
When happy with the final deck, I simply comment out the code of the reload button. You will need it later…

```
index: my first button
index: reload
type: reload
icon: reload.png
```
Expand Down Expand Up @@ -117,7 +117,7 @@ Now just go and take off for new adventures.

Using an external file watcher, it is possible to provoke a deck reload each time a file has been saved, using curl(1) to post a request for page reload to Cockpitdecks. There is a handy shell script that does exactly this using nodejs nodemon utility.

```
```sh
$ nodemon -w aircrafts/*/deckconfig/resources/decks/types -e yaml --exec curl "http://127.0.0.1:7777/reload-decks"
```

Expand Down
8 changes: 4 additions & 4 deletions docs/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,10 @@ $ cockpitdecks-cli

#### For Cockpitdecks Developers

If you cloned Cockpitdecks sofware in a folder, you can start Cockpitdecks with
If you cloned Cockpitdecks software in a folder, you can start Cockpitdecks with

```shell
$ python start.py
$ python cockpitdecks/start.py
```

from the top folder of the source code.
Expand All @@ -149,7 +149,7 @@ $ cockpitdecks-cli

### Start Cockpitdecks

To start Cockpitdecks, use the `cockpitdecks_start.py` script by supplying the X-Plane aircraft folder where deck confit resides. Start the python script and supply the folder name where `deckconfig` folder resides.
To start Cockpitdecks, use the `cockpitdecks-cli` script by supplying the X-Plane aircraft folder where deck confit resides. Start the python script and supply the folder name where `deckconfig` folder resides.

```shell
$ cockpitdecks-cli "/Applications/X-Plane 12/Aircraft/Extra Aircraft/Toliss A321"
Expand All @@ -159,7 +159,7 @@ Cockpitdecks will look for `deckconfig` folder in the aircraft folder and start.

Cockpitdecks will repetitively try to connect to X-Plane. If it fails to connect, it infinitely tries again until it succeeds. If not connected, decks will load but no command will be issued to X-Plane and no data will come from X-Plane to update decks.

When Cocpiktdecks successfully connects to X-Plane, it refreshes all pages by *reloading* them to reflect the state of the aircraft on the decks.
When Cockpitdecks successfully connects to X-Plane, it refreshes all pages by *reloading* them to reflect the state of the aircraft on the decks.

If Cockpitdecks fails to connect to X-Plane or notices it does no longer receive dataref values from X-Plane, it will again repetitively try to connect to it until it succeeds.

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@ markdown_extensions:
- markdown.extensions.smarty:
smart_quotes: false
- pymdownx.betterem:
- pymdownx.keys
- markdown.extensions.attr_list:
- markdown.extensions.def_list:
- markdown.extensions.tables:
Expand Down

0 comments on commit 731c78e

Please sign in to comment.