Skip to content
This repository has been archived by the owner on Oct 5, 2022. It is now read-only.
/ sol-engine Public archive

Commit

Permalink
Maintenance
Browse files Browse the repository at this point in the history
Update license links in documentation, source code and distribution versions.
Improve formatting for inline code blocks in README.
Fix spelling error in README.
  • Loading branch information
krobbi committed May 1, 2021
1 parent 6c5bedb commit 3b6e392
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Most of the work on a Phaser game is done in JavaScript as there is no official
editor program for it.

[Phaser Editor 2D](https://phasereditor2d.com) is an unofficial freemium editor
for Phaser with a simmilar interface to other game engines, however it requires
for Phaser with a similar interface to other game engines, however it requires
an account to use, and the free version is limited to 70 files per project and
50MB of storage.

Expand Down Expand Up @@ -116,7 +116,7 @@ The demo page for the development (unfinished, possibly buggy) version of Sol is
located at https://krobbi.github.io/sol-engine.

# Usage
The latest distribution version of Sol can be found in the ```/dist``` folder
The latest distribution version of Sol can be found in the `dist/` folder
and specific versions of Sol can be downloaded from the
[GitHub releases page](https://github.com/krobbi/sol-engine/releases).

Expand Down Expand Up @@ -166,13 +166,13 @@ A read-only boolean property representing whether the game is running.
myGame.delta;
```
A read-only number property representing the time since the previous game tick
in seconds. Shorthand for ```myGame.time.delta```.
in seconds. Shorthand for `myGame.time.delta`.

```JavaScript
myGame.fps;
```
A read-only number property representing the number of frames per second.
Shorthand for ```myGame.time.fps```.
Shorthand for `myGame.time.fps`.

```JavaScript
// Managers:
Expand Down Expand Up @@ -302,12 +302,12 @@ alongside the full release of Sol._

# NPM
The [NPM package](https://npmjs.com/package/sol-engine) for Sol
is ```sol-engine```. This package is mainly used to provide development
is `sol-engine`. This package is mainly used to provide development
dependencies and build scripts in the repository. The package is published at
version ```0.0.0-init``` and will _not_ be updated until a full release.
version `0.0.0-init` and will _not_ be updated until a full release.

# License
MIT License - https://krobbi.github.io/license/mit-2020.txt
MIT License - https://krobbi.github.io/license/2020/mit.txt

---

Expand Down
6 changes: 3 additions & 3 deletions dist/sol.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @name Sol
* @description Lightweight JavaScript game engine.
* @version 0.2.0
* @license {@link https://krobbi.github.io/license/mit-2020.txt|MIT License}
* @license {@link https://krobbi.github.io/license/2020/mit.txt|MIT License}
* @author Chris Roberts (Krobbizoid)
* @copyright 2020 Chris Roberts
*/
Expand Down Expand Up @@ -240,9 +240,9 @@ LICENSE: "MIT",
* @constant
* @type {string}
* @name Sol.LICENSE_URL
* @default "https://krobbi.github.io/license/mit-2020.txt"
* @default "https://krobbi.github.io/license/2020/mit.txt"
*/
LICENSE_URL: "https://krobbi.github.io/license/mit-2020.txt",
LICENSE_URL: "https://krobbi.github.io/license/2020/mit.txt",
/**
* The copyright holder for this version of Sol.
* @constant
Expand Down
4 changes: 2 additions & 2 deletions dist/sol.min.js

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions src/CONST.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ const CONST = {
* @constant
* @type {string}
* @name Sol.LICENSE_URL
* @default "https://krobbi.github.io/license/mit-2020.txt"
* @default "https://krobbi.github.io/license/2020/mit.txt"
*/
LICENSE_URL: "https://krobbi.github.io/license/mit-2020.txt",
LICENSE_URL: "https://krobbi.github.io/license/2020/mit.txt",

/**
* The copyright holder for this version of Sol.
Expand Down
2 changes: 1 addition & 1 deletion src/build/bannerDev.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
* @name Sol
* @description Lightweight JavaScript game engine.
* @version 0.2.0-dev
* @license {@link https://krobbi.github.io/license/mit-2020.txt|MIT License}
* @license {@link https://krobbi.github.io/license/2020/mit.txt|MIT License}
* @author Chris Roberts (Krobbizoid)
* @copyright 2020 Chris Roberts
*/
2 changes: 1 addition & 1 deletion src/build/bannerDist.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* @name Sol
* @description Lightweight JavaScript game engine.
* @version 0.2.0
* @license {@link https://krobbi.github.io/license/mit-2020.txt|MIT License}
* @license {@link https://krobbi.github.io/license/2020/mit.txt|MIT License}
* @author Chris Roberts (Krobbizoid)
* @copyright 2020 Chris Roberts
*/

0 comments on commit 3b6e392

Please sign in to comment.