Skip to content

Commit 0bf29c4

Browse files
committed
update docs
1 parent a6c98af commit 0bf29c4

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

build.zig.zon

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.{
22
.name = "gatorcat",
3-
.version = "0.0.0",
4-
.minimum_zig_version = "0.13.0",
3+
.version = "0.1.0",
4+
.minimum_zig_version = "0.14.0",
55
.dependencies = .{
66
.flags = .{
77
.url = "https://github.com/n0s4/flags/archive/refs/tags/v0.10.0.tar.gz",

doc/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,30 @@
44
> GatorCAT is **alpha** software. Using it today means participating in its development.
55
> This means you may find bugs or need features implemented before you can use GatorCAT effectively.
66
7+
## Zig Version
8+
9+
GatorCAT targets zig master for now. We plan to stop targetting master once 0.14.0 is released.
10+
711
## Installation
812

13+
### Windows
14+
15+
On Windows, GatorCAT depends on [npcap](https://npcap.com/).
16+
17+
Please do not use windows for anything other than developer convienience (using the CLI, etc.).
18+
19+
Npcap has poor realtime performance and so does Windows in general.
20+
21+
### Linux
22+
23+
There are no system dependencies for linux.
24+
25+
### Using the Zig Package Manager
26+
927
> TODO: show how to use gatorcat as a zig dependency
1028
29+
## The CLI
30+
1131
GatorCAT provides a CLI application that can be useful for getting information about ethercat networks.
1232

1333
The CLI application can be built and run by cloning this repo and running:

0 commit comments

Comments
 (0)