From 497599eda62246d2d4fab36b845636a22c9d3633 Mon Sep 17 00:00:00 2001 From: Dmitry Vyukov Date: Fri, 1 Mar 2019 11:26:33 +0100 Subject: 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 --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) (limited to 'README.md') 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 -- cgit mrf-deployment