Updated readme.

This commit is contained in:
Anselm Levskaya 2011-12-20 21:37:53 -08:00
parent 480a1c2e68
commit d960642db1

View File

@ -1,17 +1,21 @@
De-obfuscated JSLinux
Fabrix - (De-obfuscated) JSLinux
=========================================================
I wanted to understand how the amazing [JsLinux][1] worked. However, Mr Bellard seems to have applied a decidedly french proclivity towards obfuscatory algorithmic prose, replete with two-letter variable names and the like... ;) I have no idea if he passed it through a minifier or if the code was generated algorithmically from stuff in the QEMU codebase. In any case, it's hard to follow the action as presented originally, let alone extend it to do new tricks.
So in order to better understand the code, I started transforming all the symbols and commenting it up, which isn't all that hard a thing to do given that it's been built to imitate a very well-specified piece of hardware.
In the tiny off-chance someone else might be interested I'm posting this "cheat sheet" version of the code here.
### Status
It's still absolutely ungainly, but not nearly so ungainly as the original. About a third to a half of the variables/function names have been redescribed. The names are basically long comments and will ultimately need to be redone once the whole is understood.
I highly recommend, by the way, the excellent [JSShaper][2] library for transforming large javascript code bases. The hacks I made from it are in this repo: a little symbol-name-transformer node.js script and an emacs function for doing this in live buffers.
### Caveat Coder
This is an artistic reinterpretation of Fabrice Bellard's original code. There's no alteration in the acutal algorithmic content. I do check that that it still runs. I can't guarantee anything else.
This is a pedagogical reinterpretation of the original JSLinux code Copyright (c) 2011 Fabrice Bellard.
There's no alteration in the acutal algorithmic content. I do check that that it still runs, but I can't guarantee anything else.
[1]: http://bellard.org/jslinux/tech.html
[2]: http://sshaper.org