diff --git a/README.md b/README.md index b100bff..4416a5a 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ **Tactile Terminal:** A WebUI / TUI built to help teach and study programming concepts in an interactive, hands-on way. +> I found it frustrating that there wasn't a simple, easy to use program for studying program in an interactive or kinesthetic way. So, while I worked on other projects, I decided to slop together a program and leverage local LLMs to build **TactiTerm**. +> +> A self-sufficient, offline capable IDE, with an LLM powered tutor to help guide you through mental roadblocks, and build up confidence when it comes to programming in various languages. + --- ## Overview @@ -32,7 +36,7 @@ TactiTerm features both a rich **Terminal User Interface (TUI)** for command-lin - [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 +> Currently we only officially support running TactiTerm through devbox. This is to simplify the deployment process across devices. If you dare, and you have the prequisites installed; you should be able to run TactiTerm without it. ### Installation @@ -78,7 +82,7 @@ Then open your browser to `http://localhost:5173`. --- -## ⚙️ Configuration +## Configuration When initialized, TactiTerm automatically generates a `config.json` file in the root directory if one does not exist. @@ -117,7 +121,7 @@ When initialized, TactiTerm automatically generates a `config.json` file in the --- -## 🏗️ Architecture +## Architecture - **Backend (`src/api/main.py`):** FastAPI application serving REST endpoints for challenges, code linting, code execution, mentoring guidance, and handbook references. - **Core Engine (`src/core/`):**