objectionary / jeo-maven-plugin

This Maven plugin converts Java Bytecode binary files to EOLANG programs that use the "opcode" atom
https://www.objectionary.com/jeo-maven-plugin/
MIT License
11 stars 3 forks source link

README documentation is outdated #918

Open yegor256 opened 2 days ago

yegor256 commented 2 days ago

It seems that what README is saying now (examples of translation from Java to EO) is not the actual information. I see different output in XMIR/phi. Moreover, would be great to add a section to the README explaining the meaning of every object in the jeo package. Well, at least the most important ones, like jeo.frame, jeo.label, jeo.annotation, etc.

The best way to explain them, I believe, would be as if they are real objects providing some functionality. We should just explain how they would work, if they would receive control from a virtual machine.

yegor256 commented 2 days ago

@volodya-lombrozo please, help

volodya-lombrozo commented 2 days ago

@yegor256 I suggest removing the section that describes transformation examples then, and add one more section about jeo objets. This new section would describe meaning of each jeo object as you said.

yegor256 commented 2 days ago

@volodya-lombrozo yes, makes sense