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

Missing some comprehensive instructions, packages and descriptions of projects. #59

Open
T3sT3ro opened this issue Aug 22, 2021 · 2 comments

Comments

@T3sT3ro
Copy link

T3sT3ro commented Aug 22, 2021

Right now I have to traverse jitpack, github and other repositories to know what packages there are and how to add it to the project. Not cool...

Also some description/doc about the kotlin graphics plugin and similar. I wouldn't mind the "for dummies" section.

@elect86
Copy link
Collaborator

elect86 commented Aug 23, 2021

Hi Tooster,

you are right, and I'm sorry for this. It's still a transitioning phase. Unfortunately I'm overloaded with many other (cool) stuff and lack the . A couple of these are achieving:

  • transparent multi variant artifacts publication and selection for jdk9+ and jdk8. In this way I don't have to maintain every single-jdk8 branch for each library
  • implement a nice dependency alignment for all the kotlin-graphics libraries. Traditionally, I update unsigned, then the platform with the new version, then glm and then again the platform. And so again and again. But with this new file I can simply add manually the version of every library just published, in this way I don't need to publish a new platform version every single time

Also, I'd love to know more which kind of description doc do you expect/need more and start from there. So I can better get to know your point of view, which is probably the same of many other people.

@T3sT3ro
Copy link
Author

T3sT3ro commented Aug 24, 2021

I would be happy with the following:

  • List of all available packages together with versions, maintenance status, dependencies list and automatically updated snippets with latest version. The snippet to copy-paste into Gradle should look like this one.
  • Update descriptions and READMEs of all repositories in Kotlin-graphics organization - right now there are "build logic", "ovr" and "platform" repos which I have no idea what are used for. Description "jvm gli" for repository "gli" doesn't explain a thing - use description as a TLDR about what repo does and who needs it without needing to opening it and studying the README
  • Online documentation for any projects adding some Kotlin DSL: gln, aln, openvr, uno and others
  • Examples of standalone programs using packages together with Gradle files for devs to use for reference and get started easily
  • DSL description for Gradle plugins (kxImplementation and others)
  • In the gln project (and alike): side by side comparison of original gl calls on the left and DSL version on the right - that would help a lot in understanding and searching what to use when
  • archive obsolete projects - what is ovr for example?
  • maybe add CI task to generate github packages

The most important to me are: examples, artifact coordinates to copy-paste into gradle, repo descriptions, updated READMEs and wikis + DSL docs.

Maybe a list of demos (made by community) could work out and help others

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

No branches or pull requests

2 participants