Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
panaaj committed Mar 8, 2024
1 parent 4dff321 commit 6c6ab30
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 25 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

### v2.6.0

- **Added**: Ability to show/hide toolbar buttons on both sides of the screen.
- **Added**: Ability to show / hide toolbar buttons on both sides of the screen.
- **Added**: Route builder. 1st release allows creating a route from waypoints.
- **Added**: Support for displaying S57 vector charts converted using [s57-tiler](https://github.com/wdantuma/s57-tiler).
- **Updated**: Resources created outside of Freeboard UI (plugins, etc.) are now selected for display on the map. Previously these had to be manually selected from the relevant list.
- **Fixed**: Wind speed values in vessel popover showing 0 rather than - when no value is present.

### v2.5.0
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@signalk/freeboard-sk",
"version": "2.6.0-rc2",
"version": "2.6.0-rc3",
"description": "Openlayers chart plotter implementation for Signal K",
"keywords": [
"signalk-webapp",
Expand Down
43 changes: 20 additions & 23 deletions src/assets/help/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -961,16 +961,22 @@ <h4><i class="material-icons">layers</i> Resources / Layers</h4>
the display.<br />
Vector tiles normally require a related "STYLE" to display the
elements with specific colors, etc.<br />
<i>Note: Vector tiles
that are not sourced via a mapbox style definition (mapstyleJSON),
will have a very basic style is applied to color lines and fill polygons.
</i><br />
<i
>Note: Vector tiles that are not sourced via a mapbox style
definition (mapstyleJSON), will have a very basic style is
applied to color lines and fill polygons. </i
><br />
<b>S57 ENC converted to vector tiles:</b>
Freeboard-SK is able to display S57 ENC charts that have been
converted to vector tiles with
<a href="https://github.com/wdantuma/s57-tiler" target="s57">s57-tiler</a>.
Freeboard-SK is able to display S57 ENC charts that have been
converted to vector tiles with
<a href="https://github.com/wdantuma/s57-tiler" target="s57"
>s57-tiler</a
>.
<br />
<i>Note: Only unencrypted ENC's are supported (no S63 support).</i><br />
<i
>Note: Only unencrypted ENC's are supported (no S63
support).</i
><br />
</li>
<li>
<b>mapstyleJSON:</b> A mapbox style JSON file which defines
Expand Down Expand Up @@ -1773,25 +1779,16 @@ <h4><i class="material-icons">settings</i> Settings</h4>
<img src="./img/settings_charts.png" style="width: 300px" alt="" />
<ul>
<li>
<b>Graphics Style</b>: Select this option in order to a
close a popover using a button rather than just clicking outside
of it.
<b>Graphics Style</b>: Select this option in order to a close a
popover using a button rather than just clicking outside of it.
</li>
<li>
<b>Boundaries</b>: Select from <b>Plain</b> or <b>Symbolized</b>.
</li>
<li>
<b>Colors</b>: Select from <b>2</b> or <b>4</b> colors.
</li>
<li>
<b>Shallow Depth</b>: Enter the depth in meters.
</li>
<li>
<b>Safety Depth</b>: Enter the depth in meters.
</li>
<li>
<b>Deep Depth</b>: Enter the depth in meters.
</li>
<li><b>Colors</b>: Select from <b>2</b> or <b>4</b> colors.</li>
<li><b>Shallow Depth</b>: Enter the depth in meters.</li>
<li><b>Safety Depth</b>: Enter the depth in meters.</li>
<li><b>Deep Depth</b>: Enter the depth in meters.</li>
</ul>
<hr />

Expand Down

0 comments on commit 6c6ab30

Please sign in to comment.