Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
StrawberryMaster committed Jul 8, 2023
1 parent 389ec04 commit 2eb1413
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
## [TrackGen](https://trackgen.codingcactus.repl.co/) - The simplest tropical cyclone track map generator
# [TrackGen](https://strawberrymaster.github.io/TrackGen)

This is a fork of [TrackGen](https://trackgen.codingcactus.repl.co/) by [CodingCactus](https://github.com/Coding-Cactus). I have made some changes to the code - mostly to ensure it works offline, correctly. The world background is also stored in the repository, instead of an external server.
The simplest tropical cyclone track map generator. This is a fork of [TrackGen](https://trackgen.codingcactus.repl.co/) by [CodingCactus](https://github.com/Coding-Cactus). I have made some changes to the code - mostly to ensure it works offline, correctly. The world background is also stored in the repository, instead of an external server.

## Usage

### Usage
- Each line is a point to be plotted on the map
- Each field gives information about the point to be plotted

| Field | Description | Example | Required? |
|:----------:|:------------|:-------:|:---------:|
| Name | Name of the cyclone, used to join points together | Iota | <ul><li> [ ] </li></ul> |
| Latitude | Latitude coordinate, choose either °N or °S instead of using negative numbers | 52 °N | <ul><li> [x] </li></ul> |
| Longitude | Longitude coordinate, choose either °E or °W instead of using negative numbers | 1°W | <ul><li> [x] </li></ul> |
| Wind Speed | Wind speed at that point, leave blank for unknown speeds | 25 kt | <ul><li> [ ] </li></ul> |
| Stage | Stage of tropical cyclone (determines shape used for point) | Tropical Cyclone | <ul><li> [x] </li></ul> |
| Name | Name of the cyclone, used to join points together | Iota | - [ ] Not required |
| Latitude | Latitude coordinate, choose either °N or °S instead of using negative numbers | 52 °N | - [x] Required |
| Longitude | Longitude coordinate, choose either °E or °W instead of using negative numbers | 1°W | - [x] Required |
| Wind Speed | Wind speed at that point, leave blank for unknown speeds | 25 kt | - [ ] Not required |
| Stage | Stage of tropical cyclone (determines shape used for point) | Tropical Cyclone | - [x] Required |

0 comments on commit 2eb1413

Please sign in to comment.