diff --git a/.github/PUBLISHING.md b/.github/PUBLISHING.md deleted file mode 100644 index c8a80f3..0000000 --- a/.github/PUBLISHING.md +++ /dev/null @@ -1,86 +0,0 @@ -# Publishing VeltoKit - -Checklist before making the repository public on GitHub. - -## 1. Repository settings (GitHub UI or CLI) - -Suggested **description** (≤ 350 characters): - -```text -VeltoKit — unofficial Swift SDK: BLE cap IMU → GameInput for iOS games. Sample arcade app (Pong, Dart, Bowling, Quiz) + Docusaurus docs (EN/PL). -``` - -Suggested **topics** (copy into *About* → *Topics* or use `gh repo edit`): - -```text -swift -ios -swiftui -ble -bluetooth-low-energy -motion-sdk -game-input -imu -gyroscope -corebluetooth -sample-app -docusaurus -documentation -pong -educational -reverse-engineering -veltokit -``` - -One-shot CLI (after `git remote add origin …`): - -```bash -gh repo edit \ - --description "VeltoKit — unofficial Swift SDK: BLE cap IMU → GameInput for iOS games. Sample arcade (Pong, Dart, Bowling, Quiz) + docs (EN/PL)." \ - --add-topic swift --add-topic ios --add-topic ble --add-topic motion-sdk \ - --add-topic game-input --add-topic imu --add-topic sample-app --add-topic docusaurus \ - --add-topic veltokit --add-topic educational -``` - -## 2. GitHub Pages (docs site) - -1. Push `main` to GitHub (includes `.github/workflows/deploy-website.yml`). -2. **Settings → Pages → Build and deployment**: Source = **GitHub Actions**. -3. After the workflow succeeds, open the **homepage** (not only `/docs/intro`): - -`https://koderhack.github.io/veltokit/` - -Manual fallback: - -```bash -cd website && npm ci && npm run build -# upload website/build via Actions artifact, or: npm run deploy -``` - -Do **not** set Pages source to the repo `/docs` folder — that is a legacy redirect; the product site lives in `website/`. - -## 3. Release tag (SDK snapshot — required for SPM & CocoaPods) - -SPM and CocoaPods resolve versions from **git tags**. After merging `Package.swift` and `VeltoKit.podspec`: - -```bash -git tag -a v0.1.0 -m "VeltoKit 0.1.0 — SPM, CocoaPods, sample + docs" -git push origin v0.1.0 -``` - -Bump `s.version` in `VeltoKit.podspec` and the `from:` version in docs when releasing `v0.2.0`, etc. - -Draft release notes: link to [docs intro](https://koderhack.github.io/veltokit/docs/intro), install via SPM/CocoaPods, list `VeltoKit/` + sample app, disclaimer (unofficial BLE). - -## 4. What *not* to ship - -- `website/node_modules/`, `website/build/`, `.docusaurus/` (gitignored) -- Secrets, `.env`, signing keys -- `xcuserdata/` (gitignored) - -## 5. Verify before announce - -```bash -cd app && open gametriki.xcodeproj # build gametriki on device -cd website && npm run build # EN + PL docs, no broken links -``` diff --git a/README.md b/README.md index dd9e47c..25f4041 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ [![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-0ea5e9)](https://koderhack.github.io/veltokit/) [![iOS 16+](https://img.shields.io/badge/iOS-16%2B-black)](./VeltoKit/) [![Swift](https://img.shields.io/badge/Swift-5.9%2B-orange)](./VeltoKit/) -[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](./LICENSE) [![BLE unofficial](https://img.shields.io/badge/BLE-unofficial-lightgrey)](./website/docs/intro.mdx) **VeltoKit** is an experimental Swift framework that maps **BLE cap IMU + button packets** into a single [`GameInput`](./VeltoKit/GameInput.swift) struct each frame. **gametriki** is the reference iOS sample (Pong, Dart, Bowling, Quiz) that exercises the SDK without importing CoreBluetooth in game code. @@ -95,7 +94,7 @@ app/ Sample iOS app (open app/gametriki.xcodeproj) website/ Docusaurus docs (EN + Google Translate) ``` -See also [VeltoKit/README.md](./VeltoKit/README.md) and [.github/PUBLISHING.md](./.github/PUBLISHING.md) for release tags and GitHub metadata. +See also [VeltoKit/README.md](./VeltoKit/README.md). ## Requirements @@ -113,9 +112,4 @@ open gametriki.xcodeproj Scheme **gametriki** → your iPhone → Connect BLE → pick a game from the menu. -## License - -### 🔥 MIT License - -Full text: [LICENSE](./LICENSE) diff --git a/VeltoKit/README.md b/VeltoKit/README.md index 6cf1989..e800481 100644 --- a/VeltoKit/README.md +++ b/VeltoKit/README.md @@ -32,4 +32,3 @@ Docs: https://koderhack.github.io/veltokit/docs/installation Optional **Platform** in the sample app (`app/Platform`): `TrikiInputAdapter` forwards to `MotionSDK` and adds calibration prompts. -MIT — see [LICENSE](../LICENSE). diff --git a/website/docs/can-i-use-this.md b/website/docs/can-i-use-this.md deleted file mode 100644 index 36b4a8a..0000000 --- a/website/docs/can-i-use-this.md +++ /dev/null @@ -1,43 +0,0 @@ ---- -sidebar_position: 7 -sidebar_label: Can I use this? -title: Can I use VeltoKit in my project? -description: MIT — what you can do with VeltoKit and gametriki, in plain language. ---- - -# Can I use VeltoKit in my project? - -**Yes.** VeltoKit and the **gametriki** sample app are free to use under the **MIT License**. - -You do **not** need to ask for permission to try the demo, learn from the code, or build your own iOS game with the SDK. - -## What you can do - -- Run **gametriki** on your iPhone and play with your BLE controller -- Copy **VeltoKit** into your own Xcode project -- Change the code and ship your own app (including commercial apps) -- Publish your fork on GitHub - -## What we ask you to do - -- Keep the **copyright notice** when you ship code that includes VeltoKit (standard MIT rule) -- Remember this is an **unofficial, educational** project — not an official product of any hardware brand - -## Is MIT a good fit for you? - -**Choose MIT if you want to:** - -- grow adoption quickly -- make it easy for others to pick up the project -- publish openly on GitHub -- accept that someone may fork or copy the code **within MIT rules** - -If that sounds like you — **go ahead and build.** - -## Full legal text - -The official license text lives in the repo: [LICENSE on GitHub](https://github.com/koderhack/veltokit/blob/main/LICENSE). - -For API and integration details, see [Getting started](getting-started) and [SDK overview](sdk/overview). - -[Help](faq) · [Introduction](intro) diff --git a/website/docs/faq.md b/website/docs/faq.md index 1c09f93..3da1577 100644 --- a/website/docs/faq.md +++ b/website/docs/faq.md @@ -58,10 +58,10 @@ More detail: [Demo](demo) · [Dart](examples/dart) · [Bowling](examples/bowling ### Can I use VeltoKit in my own app? -**Yes** — MIT license, free for personal and commercial use. Plain-language guide: **[Can I use this?](can-i-use-this)**. +**Yes.** Use the setup docs to integrate the SDK into your own iOS project. ### Documentation in other languages Docs are written in **English**. On the live site, use the **Translate** dropdown in the navbar (powered by Google Translate) — e.g. choose **Polish** for a machine-translated view. Code blocks and API names stay in English. -[Getting started](getting-started) · [Can I use this?](can-i-use-this) · [Introduction](intro) +[Getting started](getting-started) · [Introduction](intro) diff --git a/website/docs/intro.mdx b/website/docs/intro.mdx index 9278868..f8e35c5 100644 --- a/website/docs/intro.mdx +++ b/website/docs/intro.mdx @@ -51,7 +51,6 @@ Each demo documents **VeltoKit mode**, **GameInput** fields, and **source files* | Connect controller in one call | [Quick start](quick-start) (`connect()` + `pollInput()`) | | Wire my own BLE stack | [BLE integration](sdk/ble-integration) | | Help — app, controller, TV | [Help](faq) | -| Can I use this in my app? | [Can I use this?](can-i-use-this) | ## Repo layout diff --git a/website/sidebars.ts b/website/sidebars.ts index 20f0576..11906e9 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -7,7 +7,6 @@ const sidebars: SidebarsConfig = { 'quick-start', 'getting-started', 'installation', - 'can-i-use-this', 'faq', { type: 'category', diff --git a/website/siteRoutes.ts b/website/siteRoutes.ts index 0372671..11ea4d3 100644 --- a/website/siteRoutes.ts +++ b/website/siteRoutes.ts @@ -7,7 +7,6 @@ export const DOC_PATHS = { gettingStarted: '/docs/getting-started', installation: '/docs/installation', faq: '/docs/faq', - canIUse: '/docs/can-i-use-this', sdkOverview: '/docs/sdk/overview', sdkArchitecture: '/docs/sdk/architecture', sdkModules: '/docs/sdk/modules', @@ -92,7 +91,6 @@ export const footerLinks = [ {label: 'SDK Overview', to: d.sdkOverview}, {label: 'Demo', to: d.demo}, {label: 'Help', to: d.faq}, - {label: 'Can I use this?', to: d.canIUse}, ], }, {