Skip to content

Commit 78721a5

Browse files
committed
docs: add banner, update init and watch mode in README
1 parent e541ee0 commit 78721a5

1 file changed

Lines changed: 35 additions & 14 deletions

File tree

README.md

Lines changed: 35 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,16 @@
1-
# texforge
1+
```
2+
███████████ █████ █████ ███████████
3+
░█░░░███░░░█ ░░███ ░░███ ░░███░░░░░░█
4+
░ ░███ ░ ██████ ░░███ ███ ░███ █ ░ ██████ ████████ ███████ ██████
5+
░███ ███░░███ ░░█████ ░███████ ███░░███░░███░░███ ███░░███ ███░░███
6+
░███ ░███████ ███░███ ░███░░░█ ░███ ░███ ░███ ░░░ ░███ ░███░███████
7+
░███ ░███░░░ ███ ░░███ ░███ ░ ░███ ░███ ░███ ░███ ░███░███░░░
8+
█████ ░░██████ █████ █████ █████ ░░██████ █████ ░░███████░░██████
9+
░░░░░ ░░░░░░ ░░░░░ ░░░░░ ░░░░░ ░░░░░░ ░░░░░ ░░░░░███ ░░░░░░
10+
███ ░███
11+
░░██████
12+
░░░░░░
13+
```
214

315
[![CI](https://github.com/JheisonMB/texforge/actions/workflows/ci.yml/badge.svg)](https://github.com/JheisonMB/texforge/actions/workflows/ci.yml)
416
[![Release](https://github.com/JheisonMB/texforge/actions/workflows/release.yml/badge.svg)](https://github.com/JheisonMB/texforge/actions/workflows/release.yml)
@@ -83,20 +95,12 @@ npx skills add https://github.com/jheisonmb/skills --skill texforge
8395
## Quick Start
8496

8597
```bash
86-
# Create a new project from a template
87-
texforge new mi-tesis
88-
89-
# Check for errors without compiling
90-
texforge check
98+
# Interactive wizard — new project or migrate existing
99+
texforge init
91100

92-
# Format your .tex files
93-
texforge fmt
94-
95-
# Build to PDF
101+
# Or directly:
102+
texforge new mi-tesis
96103
texforge build
97-
98-
# Remove build artifacts
99-
texforge clean
100104
```
101105

102106
## Workflow
@@ -128,9 +132,26 @@ sequenceDiagram
128132
Tectonic-->>User: build/main.pdf
129133
```
130134

135+
## `texforge init`
136+
137+
Interactive wizard. Auto-detects the context:
138+
139+
- If a `.tex` file with `\documentclass` is found in the current directory — migrates the existing project (asks for title and author, generates `project.toml`)
140+
- Otherwise — guides creation of a new project (asks for name and template)
141+
142+
```bash
143+
# Existing LaTeX project
144+
cd mi-tesis-existente/
145+
texforge init
146+
147+
# Empty directory
148+
mkdir mi-nuevo-doc && cd mi-nuevo-doc
149+
texforge init
150+
```
151+
131152
---
132153

133-
## Commands
154+
134155

135156
| Command | Description |
136157
|---|---|

0 commit comments

Comments
 (0)