aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorDmitry Vyukov <dvyukov@google.com>2019-03-01 11:26:33 +0100
committerGitHub <noreply@github.com>2019-03-01 11:26:33 +0100
commit497599eda62246d2d4fab36b845636a22c9d3633 (patch)
tree68da1b7415044f3b901a4ab0385f8091de6f6931 /README.md
parent1086acdad1d14ce7febddf06fcea80b4252562fc (diff)
docs: improve README.md
1. Mention OpenBSD 2. Properly spell OS names (capitalize) 3. Shorten text for the mailing list 4. Remove indirection for found bugs
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files changed, 3 insertions, 4 deletions
diff --git a/README.md b/README.md
index f94d39ca5..a4c5a2c64 100644
--- a/README.md
+++ b/README.md
@@ -6,12 +6,11 @@
[![GoDoc](https://godoc.org/github.com/google/syzkaller?status.svg)](https://godoc.org/github.com/google/syzkaller)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
-`syzkaller` is an unsupervised coverage-guided kernel fuzzer. `Linux` kernel fuzzing has the most support, `akaros`, `freebsd`, `fuchsia`, `netbsd`, `windows` and `gvisor` are supported to varying degrees.
+`syzkaller` is an unsupervised coverage-guided kernel fuzzer. Supported OSes: `Akaros`, `FreeBSD`, `Fuchsia`, `gVisor`, `Linux`, `NetBSD`, `OpenBSD`, `Windows`.
-The project mailing list is [syzkaller@googlegroups.com](https://groups.google.com/forum/#!forum/syzkaller).
-You can subscribe to it with a google account or by sending an email to syzkaller+subscribe@googlegroups.com.
+Mailing list: [syzkaller@googlegroups.com](https://groups.google.com/forum/#!forum/syzkaller) (join on [web](https://groups.google.com/forum/#!forum/syzkaller) or by [email](mailto:syzkaller+subscribe@googlegroups.com)).
-[List of found bugs](docs/found_bugs.md).
+Found bugs: [Akaros](docs/akaros/found_bugs.md), [Darwin/XNU](docs/darwin/README.md), [FreeBSD](docs/freebsd/found_bugs.md), [Linux](docs/linux/found_bugs.md), [NetBSD](docs/netbsd/found_bugs.md), [OpenBSD](docs/openbsd/found_bugs.md), [Windows](docs/windows/README.md).
## Documentation