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 3, 2024
1 parent d7ef0ae commit 13878e3
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 5 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

- **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).
- **Fixed**: Wind speed values in vessel popover showing 0 rather than - when no value is present.

### v2.5.0
Expand Down
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,20 +117,27 @@ _Note: The `Signal K Instrument Panel` app will be displayed if no user selectio

---

### S57 charts
### S57 Charts

Freeboard-SK is able to display S57 ENC's converted to vector tiles with [s57-tiler](https://github.com/wdantuma/s57-tiler), see the s57-tiler README for instructions how to create the vectortiles from downloaded S57 ENC's. Only unencrypted ENC's are supported ( no S63 support). Also the @signalk/charts-plugin *(Chart paths)* needs to be installed
Freeboard-SK is able to display S57 ENC charts that have been converted to vector tiles with [s57-tiler](https://github.com/wdantuma/s57-tiler). _(See the [README](https://github.com/wdantuma/s57-tiler) for instructions how to create the vectortiles from downloaded S57 ENC's.)_

See [Open CPN chart sources](https://opencpn.org/OpenCPN/info/chartsource.html) for a list of possible download locations
See [Open CPN chart sources](https://opencpn.org/OpenCPN/info/chartsource.html) for a list of locations to source charts.

![S57 Chart](images/S57%20chart.png)
_Note: Only unencrypted ENC's are supported (no S63 support)._

**_Requires: @signalk/charts-plugin_**


![S57 chart](https://github.com/SignalK/freeboard-sk/assets/38519157/a93b3889-d1c8-4df7-9f6f-97a1666fbf77)

Rendering of the Shallow, safety and deep depths and can be configured in the settings dialog

![S57 Settings](images/S57%20Settings.png)
![S57 Settings](https://github.com/SignalK/freeboard-sk/assets/38519157/0409492b-1ee7-4905-b5b0-e5fc8e68bc9a)

_Note: This functionality is not a replacement for official navigational charts_

---

### Experiments:

Features that are not ready for "prime time" are made available as experiments.
Expand Down
Binary file removed images/S57 Settings.png
Binary file not shown.
Binary file removed images/S57 chart.png
Binary file not shown.

0 comments on commit 13878e3

Please sign in to comment.