Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update root README.md after last changes + create separate README for docs and future fmf sub-modules #19

Closed
im-konge opened this issue Feb 7, 2024 · 0 comments · Fixed by #25
Milestone

Comments

@im-konge
Copy link
Member

im-konge commented Feb 7, 2024

The current README.md is not accurate after last PRs:

  • the generator is not delivered as jar but as Maven plugin
  • it should contain configuration of the plugin
  • there is TODO for the overview
  • it misses @SuiteDoc annotation
  • Makefiles are not part of the repository

Also, I think we should separate the README.md into multiple files, where in root of this repository will be simple overview with links to the other files. And then each README.md for particular generator - currently there is just documentation generator, but in case that we will add fmf generator, it should be in separate module, thus separate README.md

@Frawless Frawless added this to the 0.1.0 milestone Feb 15, 2024
@Frawless Frawless linked a pull request Feb 16, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants