Skip to content

Commit fd03c64

Browse files
moar docs to markdown
1 parent 63fe297 commit fd03c64

File tree

2 files changed

+6
-8
lines changed

2 files changed

+6
-8
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
To compare notes with other users or get notified about major new features,
8181
send a mail to <[email protected]>.
8282

83-
See [docs/QuickStartGuide.txt](docs/QuickStartGuide.txt) if you don't have time to
83+
See [docs/QuickStartGuide.md](docs/QuickStartGuide.md) if you don't have time to
8484
read this file.
8585

8686

@@ -250,7 +250,7 @@ automatically enable code hardening options that make it easier to detect
250250
simple memory bugs. Libdislocator, a helper library included with AFL (see
251251
[libdislocator/README.md](libdislocator/README.md)) can help uncover heap corruption issues, too.
252252

253-
PS. ASAN users are advised to review [docs/notes_for_asan.txt](docs/notes_for_asan.txt)
253+
PS. ASAN users are advised to review [docs/notes_for_asan.md](docs/notes_for_asan.md)
254254
file for important caveats.
255255

256256

@@ -278,7 +278,7 @@ your binary, then you can use afl-fuzz normally and it will have twice
278278
the speed compared to qemu_mode.
279279

280280
A more comprehensive description of these and other options can be found in
281-
[docs/binaryonly_fuzzing.txt](docs/binaryonly_fuzzing.txt)
281+
[docs/binaryonly_fuzzing.md](docs/binaryonly_fuzzing.md)
282282

283283

284284
## 5) Power schedules
@@ -598,7 +598,7 @@ Here are some of the most important caveats for AFL:
598598
experimental/post_library/ (with AFL_POST_LIBRARY)
599599

600600
- There are some unfortunate trade-offs with ASAN and 64-bit binaries. This
601-
isn't due to any specific fault of afl-fuzz; see [docs/notes_for_asan.txt](docs/notes_for_asan.txt)
601+
isn't due to any specific fault of afl-fuzz; see [docs/notes_for_asan.md](docs/notes_for_asan.md)
602602
for tips.
603603

604604
- There is no direct support for fuzzing network services, background

docs/QuickStartGuide.txt renamed to docs/QuickStartGuide.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
=====================
2-
AFL quick start guide
3-
=====================
1+
# AFL quick start guide
42

53
You should read docs/README.md - it's pretty short. If you really can't, here's
64
how to hit the ground running:
@@ -50,7 +48,7 @@ how to hit the ground running:
5048
That's it. Sit back, relax, and - time permitting - try to skim through the
5149
following files:
5250

53-
- docs/README.md - A general introduction to AFL,
51+
- README.md - A general introduction to AFL,
5452
- docs/perf_tips.txt - Simple tips on how to fuzz more quickly,
5553
- docs/status_screen.txt - An explanation of the tidbits shown in the UI,
5654
- docs/parallel_fuzzing.txt - Advice on running AFL on multiple cores.

0 commit comments

Comments
 (0)