Make examples folder somewhat more focused

2021-03-05 06:09:12 -08:00
parent 5141d00992
commit e26bdbec52
29 changed files with 133 additions and 1225 deletions
--- a/examples/x86split.c
+++ b/examples/x86split.c
@ -16,6 +16,24 @@

 /**
 * @fileoverview x86 instruction length decoder by way of hex pipe.
+ *
+ * Here's an example of how you can use it to decode a NOP stream:
+ *
+ *     $ make -j8 o//examples/x86split.com
+ *     $ echo 909090 | o//examples/x86split.com
+ *     90
+ *     90
+ *     90
+ *
+ * If there was a XOR instruction in there, it'd do this:
+ *
+ *     $ make -j8 o//examples/x86split.com
+ *     $ echo 904531FF90 | o//examples/x86split.com
+ *     90                     # NOP
+ *     4531FF                 # XOR R15D,R15D
+ *     90                     # NOP
+ *
+ * Now that you're able to split x86 instructions the rest is easy.
 */

 int fgethex(FILE *f) {