pfalcon / ScratchABlock

Yet another crippled decompiler project
https://github.com/EiNSTeiN-/decompiler/issues/9#issuecomment-103221200
GNU General Public License v3.0
104 stars 23 forks source link

docs/PseudoC-spec: Fix markup. #1

Closed mewmew closed 7 years ago

mewmew commented 7 years ago

Insert line breaks and prevent * from making text italic.

Before:

The syntax is: (type)expr. Examples:

After:

The syntax is: *(type*)expr. Examples:

Before:

$a0 = (u32)$a0 $a0 = (u8)($a1 + $a2) $eax = (u32)($ebx + $ecx * 8 + 3)

After:

$a0 = *(u32*)$a0
$a0 = *(u8*)($a1 + $a2)
$eax = *(u32*)($ebx + $ecx * 8 + 3)
pfalcon commented 7 years ago

Thanks! That doc spent quite a lot of time in my git stash, and I knew needs more editing passes, but somehow I decided to push whatever it was.

I wasn't exactly sure about "c" in

```c
mewmew commented 7 years ago

I'd like to keep the docs readable even as the plain text, and that "c" is a noise then

Feel free to remove the "c". It is intended to provide syntax highlighting for GitHub Flavoured Markdown.