diff --git a/Documentation/Coding Conventions & Design Decisions.md b/Documentation/Coding Conventions & Design Decisions.md index 355f3f53..4d205457 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.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html - diff --git a/Documentation/TODO & Roadmap.md b/Documentation/TODO & Roadmap.md index a1107528..f840d608 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.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html - - diff --git a/Documentation/Tips & Troubleshooting.md b/Documentation/Tips & Troubleshooting.md index 9d1eaf29..8b4e2797 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.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html diff --git a/Documentation/Usage Guide.md b/Documentation/Usage Guide.md index cdcced27..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: @@ -270,9 +274,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.io [license]: https://www.apache.org/licenses/LICENSE-2.0.html [quickstart-project]: ../../../releases diff --git a/README.md b/README.md index 95262322..2db4ef10 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.io +[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