docs: cleaned up readme, 3rd party license, etc. #524
Conversation
| @@ -0,0 +1,6 @@ | |||
| # Sysroots | |||
There was a problem hiding this comment.
Per guidance from @wackoisgod , the root folder just needs a README
| @@ -1,7 +1,7 @@ | |||
| { | |||
| "name": "com.unity.multiplayer.mlapi", | |||
| "displayName": "MLAPI Networking Library", | |||
| "version": "0.0.1-preview.1", | |||
| "version": "0.1.0", | |||
There was a problem hiding this comment.
Ignore, this is coming from the ci fix
| @@ -1,6 +1,17 @@ | |||
| MIT License | |||
| This package contains third-party software components governed by the license(s) indicated below: | |||
There was a problem hiding this comment.
For some reason Git thinks this was a file move not a new third party file, probably because I deleted the LICENSE.md file from the root dir per @wackoisgod's guidance
mattwalsh-unity
changed the title
mattwalsh-unity
changed the title
README.md
Outdated
|
|
||
| Contents: | ||
| * com.unity.multiplayer.mlapi -- the MLAPI SDK | ||
| * com.unity.multiplayer.transport.utp -- the UTP transport library |
There was a problem hiding this comment.
nit: this isn't the UTP library - just a wrapper/interface to it :)
There was a problem hiding this comment.
Moving these files into the mlapi sub-directory may be what the package standards demand, but it also partially breaks github norms - e.g. the auto-detection of the license for the repo. Any harm in having stuff like license and contributing in both places if it really is required in the package dir?
|
I guess there is no specific reason it couldn’t be replicated in the root other than maintenance. Though I did look at the graphics repo and does include a Lic file in the root. |
|
I think at least contributing and code of conduct should stay in the root? Like they don't have to be in the package and it will only confuse people downloading it? Readme is something we definitively want to at least have mirrored in the root. |
|
Ok, I have moved copies of CODE_OF_CONDUCT and LICENSE and CONTRIBUTING to the root dir. |
MTT-476