Clean up readme, and default config
This commit is contained in:
@@ -6,21 +6,21 @@
|
||||
|
||||
## Overview
|
||||
|
||||
**TactiTerm** is an interactive software engineering tutor designed with a "guidance over answers" philosophy. Rather than providing copy-paste solutions, TactiTerm uses a **Socratic AI Mentor** to ask probing questions, provide hints, and guide users toward mastering concepts across 10 programming languages.
|
||||
**TactiTerm** is an interactive software engineering tutor designed with a "guidance over answers" philosophy. Rather than providing copy-paste solutions, TactiTerm utilizes an **LLM Harness** to ask probing questions, provide hints, and guide users toward mastering concepts across various languages.
|
||||
|
||||
TactiTerm features both a rich **Terminal User Interface (TUI)** for command-line productivity and a modern **Web UI** featuring the Monaco Editor.
|
||||
TactiTerm features both a rich **Terminal User Interface (TUI)** for command-line use, and a modern **Web UI** featuring the Monaco Editor.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- **Socratic AI Mentor:** Provides step-by-step guidance, code review, and conceptual hints without spoiling direct answers.
|
||||
- **AI Mentor:** Provides step-by-step guidance, code review, and conceptual hints without spoiling direct answers.
|
||||
- **Dual Interfaces:**
|
||||
- **TUI:** Built with Python and Textual for high-productivity, keyboard-driven terminal workflows.
|
||||
- **TUI:** Built with Python and Textual for lightweight, keyboard-driven terminal workflows.
|
||||
- **Web UI:** Built with React, Vite, TypeScript, Tailwind CSS, and Monaco Editor.
|
||||
- **10 Supported Languages:** Python, C#, C++, Java, JavaScript, TypeScript, Rust, Lua, HTML, and Go.
|
||||
- **Real-time Linting & Execution:** Tree-sitter powered syntax validation and safe local code execution.
|
||||
- **Interactive Syntax Handbook:** W3Schools-style reference catalog with on-demand AI code examples for functions and core language topics.
|
||||
- **Interactive Syntax Handbook:** Comprehensive reference catalog with on-demand AI code examples for functions and core language topics.
|
||||
- **AI Challenge Generator (GenTUI):** Create and save custom Markdown programming challenges tailored to specific subjects and difficulties.
|
||||
- **Configurable & Network Ready:** Easily configure LLM endpoints, ports, and enable `"public": true` to host the Web UI across your local network (`0.0.0.0`).
|
||||
|
||||
@@ -30,10 +30,9 @@ TactiTerm features both a rich **Terminal User Interface (TUI)** for command-lin
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Python 3.10+
|
||||
- [`uv`](https://github.com/astral-sh/uv) (Python package runner)
|
||||
- Node.js & npm (for Web UI)
|
||||
- [Devbox](https://www.jetify.com/devbox) (optional, for reproducible envs)
|
||||
- [Devbox](https://www.jetify.com/devbox)
|
||||
|
||||
> Currently we only officially support running this through devbox to simplify deployment, though if you have the prequisites installed, you should be able to run TactiTerm without it
|
||||
|
||||
### Installation
|
||||
|
||||
@@ -45,30 +44,35 @@ TactiTerm features both a rich **Terminal User Interface (TUI)** for command-lin
|
||||
|
||||
2. Install dependencies:
|
||||
```bash
|
||||
make install
|
||||
devbox run install
|
||||
```
|
||||
*(or `make install` inside `devbox shell`)*
|
||||
|
||||
---
|
||||
|
||||
## 🎮 Usage
|
||||
## Usage
|
||||
|
||||
TactiTerm is executed via the use of **Devbox** run commands.
|
||||
|
||||
### Terminal Interface (TUI)
|
||||
|
||||
Launch the interactive terminal application:
|
||||
```bash
|
||||
make tui
|
||||
devbox run tui
|
||||
```
|
||||
*(or `make tui` inside `devbox shell`)*
|
||||
|
||||
Additional TUI modes:
|
||||
- `make gentui` - Launch the standalone GenTUI AI Challenge Generator.
|
||||
- `make tui-debug` - Launch TUI in debug logging mode.
|
||||
- `devbox run gentui` - Launch the standalone GenTUI AI Challenge Generator.
|
||||
- `devbox run -- make tui-debug` - Launch TUI in debug logging mode.
|
||||
|
||||
### Web Interface (Web UI)
|
||||
|
||||
Launch the FastAPI backend server and Vite frontend dev server:
|
||||
```bash
|
||||
make web
|
||||
devbox run web
|
||||
```
|
||||
*(or `make web` inside `devbox shell`)*
|
||||
|
||||
Then open your browser to `http://localhost:5173`.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user