aws-samples / aws-tools-for-babylonjs-editor

AWS Tools for Babylon.JS Editor is a suite of tools meant to interact with Babylon.JS Editor by utilizing the capabilities of AWS products.
Apache License 2.0
32 stars 9 forks source link

Update Top Level README #13

Closed brhook-aws closed 2 years ago

brhook-aws commented 2 years ago

Description

Updated top-level README in the repository. This includes information for the sub-packages and general code pulling instructions. Update lower-level package README to template out a standard for referencing by the top-level package. I've also added installation instructions to these packages to include the NPM install route, to better imply that that section is meant to be for users to install.

The philosophy was taken into consideration with this push:

  1. The top-level repo can utilize relative references to the lower packages
  2. Lower-level packages can't utilize relative references to the top-level repo (as they may be seen in NPM without the repo)
  3. Any contributing is implied to be done from a Git clone of the repo, and not just on individual packages

Testing done


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.