doc(netxlite): revamp the documentation (#523)
Part of https://github.com/ooni/probe-cli/pull/506. In parallel with tutorials, we also need to make sure we have good documentation.
This commit is contained in:
parent
b9a844ecee
commit
b2b1a4b2f1
39 changed files with 399 additions and 210 deletions
|
|
@ -1,3 +1,19 @@
|
|||
# Directory github.com/ooni/probe-cli/internal
|
||||
|
||||
This directory contains private Go packages.
|
||||
|
||||
As a reminder, you can always check the Go documentation of
|
||||
a package by using
|
||||
|
||||
```bash
|
||||
go doc -all ./internal/$package
|
||||
```
|
||||
|
||||
where `$package` is the name of the package.
|
||||
|
||||
Some notable packages:
|
||||
|
||||
- [netxlite](netxlite) is the underlying networking library;
|
||||
|
||||
- [tutorial](tutorial) contains tutorials on writing new experiments,
|
||||
using measurements libraries, and networking code.
|
||||
|
|
|
|||
Loading…
Reference in a new issue