diff options
-rw-r--r-- | README.md | 8 | ||||
-rw-r--r-- | docs/QuickStartGuide.md (renamed from docs/QuickStartGuide.txt) | 6 |
2 files changed, 6 insertions, 8 deletions
diff --git a/README.md b/README.md index dbfdb2cc..e2e073ac 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ To compare notes with other users or get notified about major new features, send a mail to <afl-users+subscribe@googlegroups.com>. - See [docs/QuickStartGuide.txt](docs/QuickStartGuide.txt) if you don't have time to + See [docs/QuickStartGuide.md](docs/QuickStartGuide.md) if you don't have time to read this file. @@ -250,7 +250,7 @@ automatically enable code hardening options that make it easier to detect simple memory bugs. Libdislocator, a helper library included with AFL (see [libdislocator/README.md](libdislocator/README.md)) can help uncover heap corruption issues, too. -PS. ASAN users are advised to review [docs/notes_for_asan.txt](docs/notes_for_asan.txt) +PS. ASAN users are advised to review [docs/notes_for_asan.md](docs/notes_for_asan.md) file for important caveats. @@ -278,7 +278,7 @@ your binary, then you can use afl-fuzz normally and it will have twice the speed compared to qemu_mode. A more comprehensive description of these and other options can be found in -[docs/binaryonly_fuzzing.txt](docs/binaryonly_fuzzing.txt) +[docs/binaryonly_fuzzing.md](docs/binaryonly_fuzzing.md) ## 5) Power schedules @@ -598,7 +598,7 @@ Here are some of the most important caveats for AFL: experimental/post_library/ (with AFL_POST_LIBRARY) - There are some unfortunate trade-offs with ASAN and 64-bit binaries. This - isn't due to any specific fault of afl-fuzz; see [docs/notes_for_asan.txt](docs/notes_for_asan.txt) + isn't due to any specific fault of afl-fuzz; see [docs/notes_for_asan.md](docs/notes_for_asan.md) for tips. - There is no direct support for fuzzing network services, background diff --git a/docs/QuickStartGuide.txt b/docs/QuickStartGuide.md index 723611e3..1e89a6ad 100644 --- a/docs/QuickStartGuide.txt +++ b/docs/QuickStartGuide.md @@ -1,6 +1,4 @@ -===================== -AFL quick start guide -===================== +# AFL quick start guide You should read docs/README.md - it's pretty short. If you really can't, here's how to hit the ground running: @@ -50,7 +48,7 @@ how to hit the ground running: That's it. Sit back, relax, and - time permitting - try to skim through the following files: - - docs/README.md - A general introduction to AFL, + - README.md - A general introduction to AFL, - docs/perf_tips.txt - Simple tips on how to fuzz more quickly, - docs/status_screen.txt - An explanation of the tidbits shown in the UI, - docs/parallel_fuzzing.txt - Advice on running AFL on multiple cores. |