Skip to content

Commit

Permalink
Rename the readme and license files to match standard (#5272)
Browse files Browse the repository at this point in the history
Do not show in changelog
  • Loading branch information
st-Wook committed May 4, 2023
1 parent 0c0fb5d commit 8fb139f
Show file tree
Hide file tree
Showing 18 changed files with 30 additions and 31 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
8 changes: 4 additions & 4 deletions Core/license.md → Core/LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions Core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 😎

Expand All @@ -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.
8 changes: 4 additions & 4 deletions Extensions/license.md → Extensions/LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion Extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

/*!
* TERMS OF USE - EASING EQUATIONS
* Open source under the BSD License.
Expand All @@ -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 */
10 changes: 5 additions & 5 deletions GDJS/license.md → GDJS/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
GDevelop JS Plaform (GDJS)
GDevelop JS Platform (GDJS)
--------------------------------

The MIT License (MIT)
Expand All @@ -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
---------------------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion GDJS/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
File renamed without changes.
8 changes: 4 additions & 4 deletions GDevelop.js/license.md → GDevelop.js/LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion GDevelop.js/Readme.md → GDevelop.js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
8 changes: 4 additions & 4 deletions newIDE/license.md → newIDE/LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion newIDE/docs/Nightly-Builds-and-continuous-deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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`)

Expand Down
File renamed without changes.

0 comments on commit 8fb139f

Please sign in to comment.