docs: reformat README.md
This commit is contained in:
parent
0f048dc47d
commit
a951162c52
1 changed files with 20 additions and 19 deletions
21
README.md
21
README.md
|
|
@ -9,6 +9,7 @@
|
||||||
|___/
|
|___/
|
||||||
T H E N I G H T W A T C H
|
T H E N I G H T W A T C H
|
||||||
```
|
```
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
> The city sleeps.
|
> The city sleeps.
|
||||||
|
|
@ -29,7 +30,7 @@ It does not interfere.
|
||||||
It does not speculate.
|
It does not speculate.
|
||||||
It simply keeps watch.
|
It simply keeps watch.
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
---
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|
@ -51,7 +52,7 @@ The Watch is written in **Zig** and built using the Zig build system.
|
||||||
|
|
||||||
## Build CLI
|
## Build CLI
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
zig build
|
zig build
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -61,11 +62,11 @@ The executable will be located in:
|
||||||
|
|
||||||
## Install System-Wide
|
## Install System-Wide
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
zig build install
|
zig build install
|
||||||
```
|
```
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
---
|
||||||
|
|
||||||
# Using as a Zig Module
|
# Using as a Zig Module
|
||||||
|
|
||||||
|
|
@ -74,7 +75,7 @@ other Zig programs.
|
||||||
|
|
||||||
In your `build.zig`:
|
In your `build.zig`:
|
||||||
|
|
||||||
``` zig
|
```zig
|
||||||
const nightwatch = b.dependency("nightwatch", .{
|
const nightwatch = b.dependency("nightwatch", .{
|
||||||
.target = target,
|
.target = target,
|
||||||
.optimize = optimize,
|
.optimize = optimize,
|
||||||
|
|
@ -85,29 +86,29 @@ exe.root_module.addImport("nightwatch", nightwatch.module("nightwatch"));
|
||||||
|
|
||||||
In your Zig source:
|
In your Zig source:
|
||||||
|
|
||||||
``` zig
|
```zig
|
||||||
const nightwatch = @import("nightwatch");
|
const nightwatch = @import("nightwatch");
|
||||||
```
|
```
|
||||||
|
|
||||||
You now have programmatic access to the tracking engine.
|
You now have programmatic access to the tracking engine.
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
---
|
||||||
|
|
||||||
# CLI Usage
|
# CLI Usage
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
nightwatch [{path}..]
|
nightwatch [{path}..]
|
||||||
```
|
```
|
||||||
|
|
||||||
Run:
|
Run:
|
||||||
|
|
||||||
``` bash
|
```bash
|
||||||
nightwatch --help
|
nightwatch --help
|
||||||
```
|
```
|
||||||
|
|
||||||
for full command documentation.
|
for full command documentation.
|
||||||
|
|
||||||
------------------------------------------------------------------------
|
---
|
||||||
|
|
||||||
# Philosophy
|
# Philosophy
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue