search

nmfisher / thermion

3D rendering toolkit for Dart and/or Flutter
https://thermion.dev
Apache License 2.0
125 stars 10 forks source link

Improve documentation #38

Open nmfisher opened 5 months ago

nmfisher commented 5 months ago

I plan to keep this issue open indefinitely - please leave any requests/comments about improving the documentation below.

Hannnes1 commented 5 months ago

A CHANGELOG.md for pub.dev would be nice, at least for future releases

Hannnes1 commented 5 months ago

A LICENCE.md would be good to have as well

nmfisher commented 4 months ago

A CHANGELOG.md for pub.dev would be nice, at least for future releases

Provided we stick to Conventional Commits, melos will auto-update the changelog for each package, so agree that this should be a commitment going forward.

nmfisher commented 4 months ago

A LICENCE.md would be good to have as well

All packages should be Apache-2.0 licensed (including the repository itself), the files are there but perhaps incorrectly named/not in the right location to get picked up by GitHub/pub.dev. Any help to fix it up is welcome :)

Hannnes1 commented 4 months ago

A LICENCE.md would be good to have as well

All packages should be Apache-2.0 licensed (including the repository itself), the files are there but perhaps incorrectly named/not in the right location to get picked up by GitHub/pub.dev. Any help to fix it up is welcome :)

Seems like it's just missing a LICENSE file at the root of the repository. #42 fixes that.

Hannnes1 commented 4 months ago

Should we add an example to thermion_flutter? Something like the one in the old flutter_filament?

nmfisher commented 4 months ago

Should we add an example to thermion_flutter? Something like the one in the old flutter_filament?

I moved all the example apps to https://github.com/nmfisher/thermion_examples (mainly to avoid storing binary sample assets in this repository).

The flutter folder contains both the old example project and the new quickstart project, are you referring to those?

Hannnes1 commented 4 months ago

I moved all the example apps to https://github.com/nmfisher/thermion_examples (mainly to avoid storing binary sample assets in this repository).

I see. The only downside is that pub.dev doesn't pick up on it, but as long as there is a way to find them that's probably fine. Perhaps we could add an example/README.md with a simple example, and a reference to the complete example in the other repo?

The flutter folder contains both the old example project and the new quickstart project, are you referring to those?

That's what I was referring to, yes.

nmfisher commented 4 months ago

Perhaps we could add an example/README.md with a simple example, and a reference to the complete example in the other repo?

I think this is a good idea

Hannnes1 commented 4 months ago

Perhaps we could add an example/README.md with a simple example, and a reference to the complete example in the other repo?

I think this is a good idea

I have some time in the next few days, so I can work on this if you'd like.

nmfisher commented 4 months ago

Perhaps we could add an example/README.md with a simple example, and a reference to the complete example in the other repo?

I think this is a good idea

I have some time in the next few days, so I can work on this if you'd like.

That would be great!