eo the structure of EO directories is not clear

Currently the process is described in EO maven plugin. It would be good to extend the description with the input/output folders structure for each step.

Jun 27 '22 12:06 mximp

@yegor256 do you find this appropriate?

Jun 27 '22 12:06 mximp

@mximp yes, definitely, would be nice to extent the README

Jun 27 '22 12:06 yegor256

@Graur fix this please (or delegate)

Aug 23 '22 19:08 yegor256

@levBagryansky please, help to improve README.md file

Aug 31 '22 10:08 Graur

@levBagryansky It would nice to have description of target/eo folder structure as well as what files are consumed/produced by each compilation step.

Aug 31 '22 10:08 mximp

@mximp so I need to imrove README.md in eo/eo-parser? How can I understand what is going on there?

Aug 31 '22 15:08 levBagryansky

@levBagryansky I'd say eo-maven-plugin/readme.md. You could run compilation, check target/eo/ and find how it's populated/used in the plugin code.

Sep 01 '22 07:09 mximp

@mximp maybe it would be better to leave a link to the post to avoid repeating?

Nov 10 '22 09:11 levBagryansky

@levBagryansky The post explains what the phases are but doesn't specify exact input and output. I believe some addition is required. I've tried to accumulate the info here as another blog post: https://github.com/mximp/news.eolang.org/commit/cc01abcc9a81143de3156d353aacd11db6bdce05. But the format is not very readable. Maybe you could think of another representation.

Nov 10 '22 11:11 mximp

@levBagryansky What's up with this issue?

Nov 14 '22 08:11 Graur

@mximp we still have this issue?

Mar 05 '23 05:03 yegor256

@Graur anything left here?

Mar 06 '23 07:03 mximp

@mximp @yegor256 Yes, we still have this issue @MikhailLipanin Can you help us here?

Mar 06 '23 10:03 Graur

@Graur Do we still need to solve that?

Mar 23 '23 08:03 volodya-lombrozo

@volodya-lombrozo I believe we should ask @mximp about it. Since we have short description in eo-maven-plugin/README.md. But is it enough?

Mar 23 '23 08:03 Graur

@Graur @volodya-lombrozo The idea was to add more detailed information about actions on files during compilation. The attempt was made here, but as I mentioned it's quite unreadable.

We could at least add a folder structure of EO plugin here: https://github.com/objectionary/eo/tree/master/eo-maven-plugin/README.md.

Mar 23 '23 11:03 mximp

@Graur I can take care of it.

Mar 23 '23 11:03 volodya-lombrozo

@volodya-lombrozo Sure, go ahead

Mar 23 '23 11:03 Graur