ruby-x/rx-file
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improve read me

Browse Source
This commit is contained in:
Torsten Ruger 2015-06-13 23:09:17 +03:00
parent 9492f29e66
commit db13ccbe41
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -12,6 +12,7 @@ But the "sort of" started to get to me, because
- 1) it's way to verbose (long files, object groups over many pages) and - 1) it's way to verbose (long files, object groups over many pages) and
- 2) does not allow for (easy) ordering. - 2) does not allow for (easy) ordering.
- 3) has no concept of dumping only parts of an object
To fix this i started on Sof, with an eye to expand it. To fix this i started on Sof, with an eye to expand it.
@ -21,7 +22,14 @@ The main starting goal was quite like yaml, but with
- also short versions of arrays and hashes - also short versions of arrays and hashes
- Shorter class names (no ruby/object or even ruby/struct stuff) - Shorter class names (no ruby/object or even ruby/struct stuff)
- references at the most shallow level - references at the most shallow level
- an easy way to order attributes and specify attributes that should not be serialized - a way specify attributes that should not be serialized
### Usage
The module's main useful api is
Sof::Writer.write(object_to_derialize)
### Salama Object File ### Salama Object File
@ -33,13 +41,13 @@ but rather very complicated.
An object machine must off course have it's own object files, because: An object machine must off course have it's own object files, because:
- otherwise we'd have to express the object machine in c (nischt gut) - otherwise we'd have to express the object machine in c formats (nischt gut)
- we would be forced to read the source every time (slow) - we would be forced to read the source every time (slow)
- we would have no language independant format - we would have no language independent format
And i was going to get there, juust not now. I mean i think it's a great idea to have many languages And i was going to get there, just not now. I mean i think it's a great idea to have many languages
compile and run on the same object machine. compile and run on the same object machine.
Not neccessarily my idea, but i haven't seen it pulled off. Not that i will. Not necessarily my idea, but i haven't seen it pulled off. Not that i will.
I just want to be able to read my compiled code!! I just want to be able to read my compiled code!!