Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 0 additions & 86 deletions .github/PUBLISHING.md

This file was deleted.

8 changes: 1 addition & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand All @@ -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)

1 change: 0 additions & 1 deletion VeltoKit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
43 changes: 0 additions & 43 deletions website/docs/can-i-use-this.md

This file was deleted.

4 changes: 2 additions & 2 deletions website/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
1 change: 0 additions & 1 deletion website/docs/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 0 additions & 1 deletion website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ const sidebars: SidebarsConfig = {
'quick-start',
'getting-started',
'installation',
'can-i-use-this',
'faq',
{
type: 'category',
Expand Down
2 changes: 0 additions & 2 deletions website/siteRoutes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down Expand Up @@ -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},
],
},
{
Expand Down