From 8fb139ff634a0a31d7db657818fa47dbf2387987 Mon Sep 17 00:00:00 2001 From: supertree-wook <88178296+st-Wook@users.noreply.github.com> Date: Thu, 4 May 2023 16:22:12 +0900 Subject: [PATCH] Rename the readme and license files to match standard (#5272) Do not show in changelog --- CMakeLists.txt | 2 +- Core/{license.md => LICENSE.md} | 8 ++++---- Core/README.md | 4 ++-- Extensions/{license.md => LICENSE.md} | 8 ++++---- Extensions/README.md | 2 +- .../{shifty.js.LICENSE.md => shifty.js.LICENSE.txt} | 3 +-- GDJS/{license.md => LICENSE.md} | 10 +++++----- GDJS/README.md | 2 +- GDJS/docs/{Readme.md => README.md} | 0 GDevelop.js/{license.md => LICENSE.md} | 8 ++++---- GDevelop.js/{Readme.md => README.md} | 2 +- license.md => LICENSE.md | 0 Readme.md => README.md | 0 SharedLibs/TileMapHelper/{ReadMe.md => README.md} | 0 newIDE/{license.md => LICENSE.md} | 8 ++++---- .../docs/Nightly-Builds-and-continuous-deployment.md | 2 +- .../Supported-JavaScript-features-and-coding-style.md | 2 +- scripts/{Readme.md => README.md} | 0 18 files changed, 30 insertions(+), 31 deletions(-) rename Core/{license.md => LICENSE.md} (93%) rename Extensions/{license.md => LICENSE.md} (93%) rename Extensions/TweenBehavior/{shifty.js.LICENSE.md => shifty.js.LICENSE.txt} (89%) rename GDJS/{license.md => LICENSE.md} (91%) rename GDJS/docs/{Readme.md => README.md} (100%) rename GDevelop.js/{license.md => LICENSE.md} (92%) rename GDevelop.js/{Readme.md => README.md} (97%) rename license.md => LICENSE.md (100%) rename Readme.md => README.md (100%) rename SharedLibs/TileMapHelper/{ReadMe.md => README.md} (100%) rename newIDE/{license.md => LICENSE.md} (92%) rename scripts/{Readme.md => README.md} (100%) diff --git a/CMakeLists.txt b/CMakeLists.txt index 1708f3727..4eb021062 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1,5 +1,5 @@ #This is the CMake file used to build GDevelop. -#For more information, see the Readme.md file. +#For more information, see the README.md file. cmake_minimum_required(VERSION 2.6) cmake_policy(SET CMP0011 NEW) diff --git a/Core/license.md b/Core/LICENSE.md similarity index 93% rename from Core/license.md rename to Core/LICENSE.md index 0ae81eb51..1c0d910f5 100644 --- a/Core/license.md +++ b/Core/LICENSE.md @@ -12,16 +12,16 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. External libraries used by GDevelop Core diff --git a/Core/README.md b/Core/README.md index b936989c9..bb31a2e9c 100644 --- a/Core/README.md +++ b/Core/README.md @@ -6,7 +6,7 @@ GDevelop Core is a portable C++ library, compiled to be used in JavaScript in th ## 1) Getting started 🤓 -First, take a look at the _Readme.md_ at the root of the repository and the [developer documentation](https://docs.gdevelop.io/). +First, take a look at the _[README.md](../README.md)_ at the root of the repository and the [developer documentation](https://docs.gdevelop.io/). ## 2) How to contribute 😎 @@ -21,5 +21,5 @@ or any pull request so as to add a nice feature, do not hesitate to get in touch ## License -GDevelop Core is distributed under the MIT license: see license.txt for +GDevelop Core is distributed under the MIT license: see [LICENSE.md](LICENSE.md) for more information. diff --git a/Extensions/license.md b/Extensions/LICENSE.md similarity index 93% rename from Extensions/license.md rename to Extensions/LICENSE.md index fb90ae74a..be70eefcb 100644 --- a/Extensions/license.md +++ b/Extensions/LICENSE.md @@ -12,16 +12,16 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. External libraries used by extensions diff --git a/Extensions/README.md b/Extensions/README.md index 7125d38ca..d54eefedb 100644 --- a/Extensions/README.md +++ b/Extensions/README.md @@ -10,5 +10,5 @@ Most extensions can be written in JavaScript. ## License -- Extensions are provided under the MIT License: see license.txt file. +- Extensions are provided under the MIT License: see [LICENSE.md](LICENSE.md) file. - External libraries can be used by extensions (Box2D, Dlib or SPARK for example). See their licenses in their directories. diff --git a/Extensions/TweenBehavior/shifty.js.LICENSE.md b/Extensions/TweenBehavior/shifty.js.LICENSE.txt similarity index 89% rename from Extensions/TweenBehavior/shifty.js.LICENSE.md rename to Extensions/TweenBehavior/shifty.js.LICENSE.txt index d24e4c303..ce9322661 100644 --- a/Extensions/TweenBehavior/shifty.js.LICENSE.md +++ b/Extensions/TweenBehavior/shifty.js.LICENSE.txt @@ -1,4 +1,3 @@ - /*! * TERMS OF USE - EASING EQUATIONS * Open source under the BSD License. @@ -14,4 +13,4 @@ * [subject to terms](http://www.robertpenner.com/easing_terms_of_use.html). */ -/*! Shifty 2.16.0 - https://github.com/jeremyckahn/shifty */ +/*! Shifty 2.20.4 - https://github.com/jeremyckahn/shifty */ diff --git a/GDJS/license.md b/GDJS/LICENSE.md similarity index 91% rename from GDJS/license.md rename to GDJS/LICENSE.md index 0b526f079..431436ed8 100644 --- a/GDJS/license.md +++ b/GDJS/LICENSE.md @@ -1,4 +1,4 @@ -GDevelop JS Plaform (GDJS) +GDevelop JS Platform (GDJS) -------------------------------- The MIT License (MIT) @@ -12,16 +12,16 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. External libraries used by GDevelop JS Platform --------------------------------------------------- diff --git a/GDJS/README.md b/GDJS/README.md index fc864a205..b84061cd9 100644 --- a/GDJS/README.md +++ b/GDJS/README.md @@ -43,5 +43,5 @@ or any pull request to add a feature, do not hesitate to get in touch. ## License -GDJS is distributed under the MIT license: see license.txt for +GDJS is distributed under the MIT license: see [LICENSE.md](LICENSE.md) for more information. diff --git a/GDJS/docs/Readme.md b/GDJS/docs/README.md similarity index 100% rename from GDJS/docs/Readme.md rename to GDJS/docs/README.md diff --git a/GDevelop.js/license.md b/GDevelop.js/LICENSE.md similarity index 92% rename from GDevelop.js/license.md rename to GDevelop.js/LICENSE.md index 2ce00a84b..a7c703908 100644 --- a/GDevelop.js/license.md +++ b/GDevelop.js/LICENSE.md @@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/GDevelop.js/Readme.md b/GDevelop.js/README.md similarity index 97% rename from GDevelop.js/Readme.md rename to GDevelop.js/README.md index 0123eca1b..3bf45ced4 100644 --- a/GDevelop.js/Readme.md +++ b/GDevelop.js/README.md @@ -49,7 +49,7 @@ npm install npm start ``` -More information in [GDevelop 5 readme](https://github.com/4ian/GD/blob/master/newIDE/README.md). +More information in [GDevelop 5 README](https://github.com/4ian/GDevelop/blob/master/newIDE/README.md). ### Tests diff --git a/license.md b/LICENSE.md similarity index 100% rename from license.md rename to LICENSE.md diff --git a/Readme.md b/README.md similarity index 100% rename from Readme.md rename to README.md diff --git a/SharedLibs/TileMapHelper/ReadMe.md b/SharedLibs/TileMapHelper/README.md similarity index 100% rename from SharedLibs/TileMapHelper/ReadMe.md rename to SharedLibs/TileMapHelper/README.md diff --git a/newIDE/license.md b/newIDE/LICENSE.md similarity index 92% rename from newIDE/license.md rename to newIDE/LICENSE.md index a42cdbfaa..dccab4600 100644 --- a/newIDE/license.md +++ b/newIDE/LICENSE.md @@ -12,13 +12,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -The above copyright notice and this permission notice shall be included in -all copies or substantial portions of the Software. +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -THE SOFTWARE. +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/newIDE/docs/Nightly-Builds-and-continuous-deployment.md b/newIDE/docs/Nightly-Builds-and-continuous-deployment.md index 470956c19..699d90605 100644 --- a/newIDE/docs/Nightly-Builds-and-continuous-deployment.md +++ b/newIDE/docs/Nightly-Builds-and-continuous-deployment.md @@ -10,7 +10,7 @@ You can download these here - **replace XX by the current version number**: > ⚠️ Be sure to check if the latest build was successfully done: [![Build status](https://circleci.com/gh/4ian/GDevelop.svg?style=shield)](https://app.circleci.com/pipelines/github/4ian/GDevelop). If this icon is not green, wait a bit before downloading the latest version. -> ⚠️ In theory, the builds from `master` branch should always be stable and working well. In practice, they are not tested and can contain bugs or regressions. Make backups of your games and **use them at your own risk**. The software is provided "as is", **without warranty of any kind**. For more information, read the [license under which GDevelop is provided](https://github.com/4ian/GDevelop/blob/master/license.txt). +> ⚠️ In theory, the builds from `master` branch should always be stable and working well. In practice, they are not tested and can contain bugs or regressions. Make backups of your games and **use them at your own risk**. The software is provided "as is", **without warranty of any kind**. For more information, read the [license under which GDevelop is provided](https://github.com/4ian/GDevelop/blob/master/LICENSE.md). ## About Nightly Builds and continuous deployment diff --git a/newIDE/docs/Supported-JavaScript-features-and-coding-style.md b/newIDE/docs/Supported-JavaScript-features-and-coding-style.md index 8a9dc83dd..6c1c0e850 100644 --- a/newIDE/docs/Supported-JavaScript-features-and-coding-style.md +++ b/newIDE/docs/Supported-JavaScript-features-and-coding-style.md @@ -30,7 +30,7 @@ The codebase is typed using **[TypeScript](https://www.typescriptlang.org/)**. It's good practice to type almost everything (i.e: avoid `any` as much as possible), so that the game engine and your extensions can have _documentation_ auto-generated, _auto-completion_ and _static type checking_ that will catch bugs and mistakes. -Learn how to launch [manually the type checking in GJDS Readme](../../GDJS/README.md). +Learn how to launch [manually the type checking in GJDS README](../../GDJS/README.md). ## For the editor (`newIDE/app`) diff --git a/scripts/Readme.md b/scripts/README.md similarity index 100% rename from scripts/Readme.md rename to scripts/README.md