Skip to content

Commit

Permalink
Revert "Update README.md"
Browse files Browse the repository at this point in the history
  • Loading branch information
marcusziade committed Oct 31, 2024
1 parent da530ef commit ddaa1fb
Showing 1 changed file with 0 additions and 31 deletions.
31 changes: 0 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,40 +27,9 @@ import StarCraftKit
```

## Terminal User Interface (TUI)

![CleanShot 2024-10-29 at 21 36 49@2x](https://github.com/user-attachments/assets/b99db46c-71e3-48e1-9db4-952730e0d427)

StarCraftTUI II is an interactive terminal-based interface built with the StarCraftKit package. It provides a user-friendly way to access StarCraft II professional scene data through a navigable menu system.

### Installation

The TUI is included as an optional executable target in the package. To use it, you have two options:

1. **Build from Source**:
```bash
git clone https://github.com/marcusziade/StarCraftKit.git
cd StarCraftKit
swift build
.build/debug/StarCraftCLI
```

2. **Include in Your Project**:
If you want to include the CLI tool in your project, add both StarCraftKit and its CLI to your dependencies:
```swift
dependencies: [
.package(url: "https://github.com/marcusziade/StarCraftKit.git", from: "1.0.0")
],
targets: [
.executableTarget(
name: "YourTarget",
dependencies: [
.product(name: "StarCraftCLI", package: "StarCraftKit")
]
)
]
```

Note: The CLI tool has an additional dependency on VimTerminalKit for the interface, but this is only required if you're using the CLI. The main StarCraftKit library can be used independently without this additional dependency.

### Features
- Interactive command menu with keyboard navigation
Expand Down

0 comments on commit ddaa1fb

Please sign in to comment.