From ae7491fb9435194644af42939ab79f94cedd01ca Mon Sep 17 00:00:00 2001 From: ShinryakuTako <> Date: Thu, 21 Jun 2018 14:42:19 +0500 Subject: [PATCH 1/3] Update docs - Standardize the footer --- .../Coding Conventions & Design Decisions.md | 6 +++--- Documentation/TODO & Roadmap.md | 7 +++---- Documentation/Tips & Troubleshooting.md | 5 +++-- Documentation/Usage Guide.md | 5 +++-- README.md | 17 +++++++++-------- 5 files changed, 21 insertions(+), 19 deletions(-) diff --git a/Documentation/Coding Conventions & Design Decisions.md b/Documentation/Coding Conventions & Design Decisions.md index 355f3f53..67bc4240 100644 --- a/Documentation/Coding Conventions & Design Decisions.md +++ b/Documentation/Coding Conventions & Design Decisions.md @@ -36,8 +36,8 @@ ---- -OctopusKit © 2018 InvadingOctopus.com, github.com/invadingoctopus/octopuskit -[Apache License 2.0][license] +OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] +[repository]: https://github.com/invadingoctopus/octopuskit +[website]: https://invadingoctopus.com [license]: https://www.apache.org/licenses/LICENSE-2.0.html - diff --git a/Documentation/TODO & Roadmap.md b/Documentation/TODO & Roadmap.md index a1107528..ed09f6f9 100644 --- a/Documentation/TODO & Roadmap.md +++ b/Documentation/TODO & Roadmap.md @@ -45,9 +45,8 @@ ---- -OctopusKit © 2018 InvadingOctopus.com, github.com/invadingoctopus/octopuskit -[Apache License 2.0][license] +OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] +[repository]: https://github.com/invadingoctopus/octopuskit +[website]: https://invadingoctopus.com [license]: https://www.apache.org/licenses/LICENSE-2.0.html - - diff --git a/Documentation/Tips & Troubleshooting.md b/Documentation/Tips & Troubleshooting.md index 9d1eaf29..144daaac 100644 --- a/Documentation/Tips & Troubleshooting.md +++ b/Documentation/Tips & Troubleshooting.md @@ -76,7 +76,8 @@ If an entity needs multiple components of the same type but with different param ---- -OctopusKit © 2018 InvadingOctopus.com, github.com/invadingoctopus/octopuskit -[Apache License 2.0][license] +OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] +[repository]: https://github.com/invadingoctopus/octopuskit +[website]: https://invadingoctopus.com [license]: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/Documentation/Usage Guide.md b/Documentation/Usage Guide.md index cdcced27..50c7d6ef 100644 --- a/Documentation/Usage Guide.md +++ b/Documentation/Usage Guide.md @@ -270,9 +270,10 @@ Set the custom class of the scene as `OctopusScene` or a subclass of it. Load th ---- -OctopusKit © 2018 InvadingOctopus.com, github.com/invadingoctopus/octopuskit -[Apache License 2.0][license] +OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] +[repository]: https://github.com/invadingoctopus/octopuskit +[website]: https://invadingoctopus.com [license]: https://www.apache.org/licenses/LICENSE-2.0.html [quickstart-project]: ../../../releases diff --git a/README.md b/README.md index 95262322..fb1a6033 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Built upon Apple's SpriteKit, GameplayKit and Metal technologies. 2. [Overview](#overview) 3. [Design Goals](#design-goals) 4. [Getting Started](#getting-started) -5. [Etcetera](#etcetera) (license, contact, etc.) +5. [Etcetera](#etcetera) (license, contact etc.) 🚀 *Anxious to dive in? Download the [Quickstart project.][quickstart-project]* @@ -214,8 +214,14 @@ Set the custom class of the scene as `OctopusScene` or a subclass of it. Load th ---- -OctopusKit © 2018 InvadingOctopus.com, github.com/invadingoctopus/octopuskit -[Apache License 2.0][license] +OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] + +[repository]: https://github.com/invadingoctopus/octopuskit +[website]: https://invadingoctopus.com +[license]: https://www.apache.org/licenses/LICENSE-2.0.html +[twitter]: https://twitter.com/invadingoctopus +[discord]: https://discord.gg/y3har7D +[patreon]: https://www.patreon.com/invadingoctopus [quickstart-&-usage-guide]: ./Documentation/Usage%20Guide.md [quickstart-project]: ../../releases @@ -226,11 +232,6 @@ OctopusKit © 2018 InvadingOctopus.com, github.com/invadingoctopus/octopuskit [swift-book]: https://docs.swift.org/swift-book/GuidedTour/GuidedTour.html [swift-api-guidelines]: https://swift.org/documentation/api-design-guidelines/ [wwdc-610]: https://developer.apple.com/videos/play/wwdc2016-610/?time=137 - [composition-over-inheritance]: https://en.wikipedia.org/wiki/Composition_over_inheritance [entity–component–system]: https://en.wikipedia.org/wiki/Entity–component–system -[patreon]: https://www.patreon.com/invadingoctopus -[twitter]: https://twitter.com/invadingoctopus -[discord]: https://discord.gg/y3har7D -[license]: https://www.apache.org/licenses/LICENSE-2.0.html From a808b82a003bf5b48db5313322ca1cc5c5cc57a0 Mon Sep 17 00:00:00 2001 From: ShinryakuTako <> Date: Thu, 21 Jun 2018 23:47:50 +0500 Subject: [PATCH 2/3] Update docs - Make invadingoctopus.io the default domain --- Documentation/Coding Conventions & Design Decisions.md | 2 +- Documentation/TODO & Roadmap.md | 2 +- Documentation/Tips & Troubleshooting.md | 2 +- Documentation/Usage Guide.md | 2 +- README.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/Coding Conventions & Design Decisions.md b/Documentation/Coding Conventions & Design Decisions.md index 67bc4240..4d205457 100644 --- a/Documentation/Coding Conventions & Design Decisions.md +++ b/Documentation/Coding Conventions & Design Decisions.md @@ -39,5 +39,5 @@ OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] [repository]: https://github.com/invadingoctopus/octopuskit -[website]: https://invadingoctopus.com +[website]: https://invadingoctopus.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/Documentation/TODO & Roadmap.md b/Documentation/TODO & Roadmap.md index ed09f6f9..f840d608 100644 --- a/Documentation/TODO & Roadmap.md +++ b/Documentation/TODO & Roadmap.md @@ -48,5 +48,5 @@ OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] [repository]: https://github.com/invadingoctopus/octopuskit -[website]: https://invadingoctopus.com +[website]: https://invadingoctopus.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/Documentation/Tips & Troubleshooting.md b/Documentation/Tips & Troubleshooting.md index 144daaac..8b4e2797 100644 --- a/Documentation/Tips & Troubleshooting.md +++ b/Documentation/Tips & Troubleshooting.md @@ -79,5 +79,5 @@ If an entity needs multiple components of the same type but with different param OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] [repository]: https://github.com/invadingoctopus/octopuskit -[website]: https://invadingoctopus.com +[website]: https://invadingoctopus.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/Documentation/Usage Guide.md b/Documentation/Usage Guide.md index 50c7d6ef..32928e2e 100644 --- a/Documentation/Usage Guide.md +++ b/Documentation/Usage Guide.md @@ -273,7 +273,7 @@ Set the custom class of the scene as `OctopusScene` or a subclass of it. Load th OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] [repository]: https://github.com/invadingoctopus/octopuskit -[website]: https://invadingoctopus.com +[website]: https://invadingoctopus.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html [quickstart-project]: ../../../releases diff --git a/README.md b/README.md index fb1a6033..2db4ef10 100644 --- a/README.md +++ b/README.md @@ -217,7 +217,7 @@ Set the custom class of the scene as `OctopusScene` or a subclass of it. Load th OctopusKit © 2018 [Invading Octopus][website] • [Apache License 2.0][license] • [github.com/invadingoctopus/octopuskit][repository] [repository]: https://github.com/invadingoctopus/octopuskit -[website]: https://invadingoctopus.com +[website]: https://invadingoctopus.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html [twitter]: https://twitter.com/invadingoctopus [discord]: https://discord.gg/y3har7D From 1ef1479d6524a8d81bef2d6c964c1a532114c6b4 Mon Sep 17 00:00:00 2001 From: ShinryakuTako <> Date: Fri, 22 Jun 2018 03:05:26 +0500 Subject: [PATCH 3/3] Update docs --- Documentation/Usage Guide.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/Documentation/Usage Guide.md b/Documentation/Usage Guide.md index 32928e2e..aad7aa05 100644 --- a/Documentation/Usage Guide.md +++ b/Documentation/Usage Guide.md @@ -21,6 +21,10 @@ 3. Modify the `TitleScene.swift` and `PlayScene.swift` files in the `Scenes` folders to customize them for your game. + > The file names are prefixed with `Step #` so you can follow the flow of execution at a glance. + > + > 💡 Browse the `OctopusKit/Components` folder and try experimenting with the different components! + > > 💡 If something goes wrong, see [Tips & Troubleshooting.][tips-&-troubleshooting] ### To import OctopusKit into a new or existing project: