Skip to content

Commit 2195ac0

Browse files
committed
Update README
1 parent 205932d commit 2195ac0

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ If you know of other public sources of harmonic constituents, please [open an is
1818

1919
The database is available as an NPM package and as an [XTide-compatible TCD file](./packages/tcd/).
2020

21-
### XTide
21+
### XTide / OpenCPN / TCD-compatible software
2222

23-
A pre-built `neaps-YYYYMMDD.tcd` file is attached to each [GitHub Release](https://github.com/openwatersio/tide-database/releases). This file is compatible with [XTide](https://flaterco.com/xtide/) and any software that reads the [libtcd](https://flaterco.com/xtide/libtcd.html) format. [See the TCD package for usage instructions.](./packages/tcd/README.md)
23+
A pre-built [TCD file](./packages/tcd/README.md) compatible with XTide, OpenCPN, and any software that reads the libtcd format. [See the TCD package for usage instructions.](./packages/tcd/README.md)
2424

2525
### JavaScript / TypeScript
2626

packages/tcd/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@ The TCD file includes all stations in the tide database, and all tidal constitue
66

77
## Usage
88

9-
Download the latest `neaps-YYYYMMDD.tcd` from [GitHub Releases](https://github.com/openwatersio/tide-database/releases).
9+
Download the latest `neaps-YYYYMMDD.tcd` from [releases](https://github.com/openwatersio/tide-database/releases).
1010

1111
### OpenCPN
1212

13-
Open the OpenCPN options, navigate to the "Charts" tab, and add the TCD file as a "Tides & Currents" data source. See the [OpenCPN manual](https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn%3Amanual\_basic%3Aset\_options%3Acharts%3Atides-currents) for more details.
13+
Open the OpenCPN options, navigate to the "Charts" tab, and add the TCD file as a "Tides & Currents" data source. See the [OpenCPN manual](https://opencpn.org/wiki/dokuwiki/doku.php?id=opencpn%3Amanual_basic%3Aset_options%3Acharts%3Atides-currents) for more details.
1414

1515
![screenshot of tide stations in OpenCPN](https://github.com/user-attachments/assets/6e57f4fd-0dad-4aae-b1db-fe638915c225)
1616

@@ -56,8 +56,8 @@ tide -l "BOSTON, MA, United States" -b "2026-01-01 00:00" -e "2026-01-08 00:00"
5656

5757
## Contributing
5858

59-
* Build the TCD file with: `npm run build`
60-
* Run tests with: `npm test`
59+
- Build the TCD file with: `npm run build`
60+
- Run tests with: `npm test`
6161

6262
## References
6363

0 commit comments

Comments
 (0)