V2 : general cleanup of readme files

[z3dev]

These are general changes to the README documents for each package.

All Submissions:

• Have you followed the guidelines in our Contributing document?
• Have you checked to ensure there aren't other open Pull Requests for the same update/change?
• Does your submission pass tests?

[z3dev]

TO DO:

• add README to @jscad/array-utils
• correct CONTRIBUTING
  • correct / merge / complete CONTRIBUTING, with specific section for each application
  • correct / add links to CONTRIBUTING from package README
  • remove unnecessary CONTRIBUTING files
• correct LICENSE:
  • correct / complete LICENSE
  • correct / add links to LICENSE from package README
  • remove unnecessary LICENCE files
• add missing sections in README files
• removed unrequired sections in README files
• removed unnessary documents

[z3dev]

During the updates, I'd like to make some adjustments to the README files.

For the UI modules, these will have full information (README, LICENSE, CONTRIBUTING)

• Usage
• Documentation
• Development => CONTRIBUTING
• Known issues ?? (shouldn't these be appropriately tagged issues?)
• Community
• Contribute
• Acknowledgements (if any apply)
• License => LICENSE
• See also (if any apply)

For component modules, these will have limited information (README)

• Usage
• Documentation (See code, and here)
• Development => CONTRIBUTING of CLI / DESKTOP / WEB
• Contribute
• Acknowledgements (if any apply)
• License (MIT, plus link to OpenJscad.org/LICENSE)

[z3dev]

@kaosat-dev what do you think about the above?

one question... should modeling have LICENSE? CONTRIBUTING?

[kaosat-dev]

@z3dev : a solid set of changes, thanks !
I do have a few notes, and mostly a thought on how to save us maintenance work : perhaps the 'contributing' document should be moved to the root of the repo, and slightly changed so that it is valid for ALL UI packages (without the need of have 99% of the same text for all of them, in each folder), any specifics can be put into the README so there is only one main manual document to maintain for each .
What do you think ?

[z3dev]

I do have a few notes, and mostly a thought on how to save us maintenance work : perhaps the 'contributing' document should be moved to the root of the repo, and slightly changed so that it is valid for ALL UI packages (without the need of have 99% of the same text for all of them, in each folder), any specifics can be put into the README so there is only one main manual document to maintain for each .
What do you think ?

Sounds good to me. Less documents to maintain is better.

I’ll merge the contributing documents that we have now, and update the links in the package specific readme documents.

I think just one LICENSE is also best. Again, one document is easily maintained. And all the readme documents just link to the main one.

[z3dev]

So... just to get this correct... as I think some of the documentation needs some changes.

• this project is composed of a set of PACKAGES
• which get published as NPM PACKAGES
• users can download and install the NPM PACKAGES as part of projects
• programs access and use the exported MODULES within each PACKAGE

[kaosat-dev]

@z3dev yes, that is exactly it !

[z3dev]

@kaosat-dev please review again. it's probably best to look at the results, not the differences.

this is taking too much time, and will probably never stop.
but if you want any more changes then let me know.

[kaosat-dev]

Sorry @z3dev , while it is good overall, there are some things still worth tweak, almost there !

[z3dev]

round one of small changes completed. :)

@kaosat-dev back to you!