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 README and Wiki #115

Open
Schmoho opened this issue May 10, 2022 · 1 comment
Open

update README and Wiki #115

Schmoho opened this issue May 10, 2022 · 1 comment

Comments

@Schmoho
Copy link
Collaborator

Schmoho commented May 10, 2022

The documentation is not very inviting currently.

  • in the first paragraph we greet the user with a troubleshooting hint -> can be moved to a troubleshooting page in the wiki
  • notes for developers on how to build the project can be moved to the wiki
    also, the building instructions reference the lightJar gradle task, which our configuration does not include
  • "how to cite" groups more naturally with the heading licenses
  • we have no user documentation that actually explains what exactly the user can expect the ModelPolisher to do -> wiki page
@Schmoho Schmoho added this to the documentation is up to date milestone May 10, 2022
@Schmoho Schmoho added this to Todo in Release 2.1 via automation May 10, 2022
@Schmoho Schmoho self-assigned this May 10, 2022
Schmoho added a commit that referenced this issue May 10, 2022
Schmoho added a commit that referenced this issue Jun 21, 2022
@GwennyGit
Copy link

For users who need to install docker before using ModelPolisher links to the corresponding installation guides would be a nice addition for the documentation.

For example:

How to install docker:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Release 2.1
  
Todo
Development

No branches or pull requests

2 participants