From 3f46aa96116686cf9c7559713ebc025adb96b58b Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Tue, 28 Jul 2020 11:11:17 +0200 Subject: [PATCH 1/3] Update documentation action --- .github/workflows/documentation.yml | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 5d76d3b..d04f299 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -2,8 +2,12 @@ name: Documentation on: push: - branches: - - master + branches: [ master ] + paths: + - .github/workflows/documentation.yml + - Sources/FirebladeECS/**.swift + pull_request: + branches: [ master ] paths: - .github/workflows/documentation.yml - Sources/FirebladeECS/**.swift @@ -13,16 +17,16 @@ jobs: runs-on: ubuntu-latest steps: - - name: Checkout - uses: actions/checkout@v1 - - name: Generate Documentation - uses: SwiftDocOrg/swift-doc@1.0.0-beta.3 + - uses: actions/checkout@v1 + - name: Generate documentation + uses: SwiftDocOrg/swift-doc@master with: - inputs: "Sources/FirebladeECS" + inputs: "FirebladeECS" output: "Documentation" - - name: Publish to GitHub Wiki - uses: SwiftDocOrg/github-wiki-publish-action@1.0.0 + - name: Publish to wiki + uses: SwiftDocOrg/github-wiki-publish-action@master with: path: "Documentation" env: + GITHUB_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }} GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }} From 35f13459325ba1012b24a5e148704d02f125cb7d Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Tue, 28 Jul 2020 11:33:10 +0200 Subject: [PATCH 2/3] Update documentation workflow --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index d04f299..58e7795 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -21,7 +21,7 @@ jobs: - name: Generate documentation uses: SwiftDocOrg/swift-doc@master with: - inputs: "FirebladeECS" + inputs: "Sources/FirebladeECS" output: "Documentation" - name: Publish to wiki uses: SwiftDocOrg/github-wiki-publish-action@master From 1468f1d28f6fb59f2d49322fdcf6ef953495ed76 Mon Sep 17 00:00:00 2001 From: Christian Treffs Date: Tue, 28 Jul 2020 11:45:51 +0200 Subject: [PATCH 3/3] Update README --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 70d36ac..3e6d878 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ This is a **dependency free**, **lightweight**, **fast** and **easy to use** [Entity-Component System](https://en.wikipedia.org/wiki/Entity_component_system) implementation in Swift. It is developed and maintained as part of the [Fireblade Game Engine project](https://github.com/fireblade-engine). -See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) to get started. +See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) or have a look at [documentation in the wiki](https://github.com/fireblade-engine/ecs/wiki) to get started. ## 🚀 Getting Started @@ -243,6 +243,10 @@ let newEntities = try family.decodeMembers(from: jsonData, using: &jsonDecoder) See the [Fireblade ECS Demo App](https://github.com/fireblade-engine/ecs-demo) to get started. +## 📖 Documentation + +Consult the [wiki](https://github.com/fireblade-engine/ecs/wiki) for in-depth [documentation](https://github.com/fireblade-engine/ecs/wiki). + ## 🏷️ Versioning We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/fireblade-engine/ecs/tags).