@bafif/foja 0.0.0-stage → 0.1.0

package/README.es.md

@@ -0,0 +1,40 @@
+# foja
+
+*[English](https://github.com/bafif/foja/blob/main/packages/cli/README.md) · Español*
+
+La línea de comandos de [Foja](https://github.com/bafif/foja), un editor de CV sobre Typst: arma
+CV a partir de un proyecto de Foja (`.foja.json`, hecho en el editor o a mano) con los mismos estilos de
+Typst que usa el editor web.
+
+Se instala con `npm install -g @bafif/foja`, que trae el comando `foja`, y `npx @bafif/foja build …` la corre sin
+instalarla. Desde una copia del repositorio, `npm run foja -- build …` la corre desde su código fuente
+([cómo](https://github.com/bafif/foja/blob/main/docs/development.es.md)).
+
+```sh
+foja build my.foja.json                       # un PDF por perfil
+foja build my.foja.json --profile dev --format pdf --format docx --out out
+foja build my.foja.json --format all          # todos los formatos en un solo .zip
+foja validate my.foja.json
+foja import plantilla.zip my.foja.json        # una plantilla de Typst o LaTeX: su contenido y su aspecto
+foja import cv.json my.foja.json              # un CV en JSON Resume
+```
+
+`import` lee una plantilla de CV de Typst o de LaTeX (`.typ`, `.tex`, `.zip` o `.tar.gz`) con reglas fijas, sin IA: su
+contenido de ejemplo pasa a ser un perfil y su aspecto un estilo propio; `--into` los suma a un proyecto que ya existe y
+`--no-style` deja afuera el aspecto. Toma la propuesta de las reglas tal como sale; el editor la muestra antes para
+revisarla. Este comando no tiene LaTeX: un perfil con una plantilla LaTeX da su `.tex` lleno (`--format tex`) y no PDF.
+Un `.json` es un CV en [JSON Resume](https://jsonresume.org): sus entradas pasan al banco y queda un perfil con sus
+secciones.
+
+Formatos: `pdf`, `svg`, `typ` (un `.zip` que compila con `typst compile` a secas), `tex` (LaTeX), `md`, `json`,
+`jsonresume` (el perfil en JSON Resume; avisa lo que no tiene lugar ahí), `docx` (Word), `all`. Necesita Node 24 o
+posterior. Los mensajes y `--help` salen en español si el sistema está en español, y en inglés si no; `--lang es` o
+`--lang en` elige uno.
+
+El formato del proyecto está descrito en su JSON Schema
+([`project.schema.json`](https://github.com/bafif/foja/blob/main/packages/core/schema/project.schema.json));
+los estilos propios, escritos en Typst, se explican en
+[`docs/templates.es.md`](https://github.com/bafif/foja/blob/main/docs/templates.es.md).
+
+Licencia: GPL-3.0. Las fuentes incluidas conservan sus propias licencias (archivos al lado de ellas en
+`dist/template/fonts`).

package/README.md

@@ -1,3 +1,40 @@
-# Temporary Holding Version
+# foja
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+*English · [Español](https://github.com/bafif/foja/blob/main/packages/cli/README.es.md)*
+
+The command line of [Foja](https://github.com/bafif/foja), a CV editor on Typst: builds CVs
+from a Foja project (`.foja.json`, made in the editor or by hand) with the same Typst styles the
+web editor uses.
+
+Install it with `npm install -g @bafif/foja`, which brings the `foja` command; `npx @bafif/foja build …` runs it
+without installing. From a clone of the repository, `npm run foja -- build …` runs it from its sources
+([how](https://github.com/bafif/foja/blob/main/docs/development.md)).
+
+```sh
+foja build my.foja.json                       # a PDF per profile
+foja build my.foja.json --profile dev --format pdf --format docx --out out
+foja build my.foja.json --format all          # every format in one .zip
+foja validate my.foja.json
+foja import template.zip my.foja.json         # a Typst or LaTeX template: its content and its look
+foja import resume.json my.foja.json          # a CV in JSON Resume
+```
+
+`import` reads a Typst or LaTeX CV template (`.typ`, `.tex`, `.zip` or `.tar.gz`) with fixed rules, no AI: its
+sample content becomes a profile and its look a style of your own; `--into` adds them to an
+existing project, `--no-style` leaves the look out. It takes the rules' proposal as it is; the
+editor shows it for review first. This command has no LaTeX: a profile with a LaTeX template gets
+its filled `.tex` (`--format tex`) and no PDF. A `.json` is a CV in [JSON Resume](https://jsonresume.org): its
+entries go to the bank, with a profile that has its sections.
+
+Formats: `pdf`, `svg`, `typ` (a `.zip` that compiles with plain `typst compile`), `tex` (LaTeX), `md`, `json`,
+`jsonresume` (the profile in JSON Resume; it says what has no place there), `docx` (Word), `all`. Needs Node 24 or
+later. Messages and `--help` come in Spanish when the system's language is Spanish and in English otherwise; `--lang es`
+or `--lang en` picks one.
+
+The project format is described by its JSON Schema
+([`project.schema.json`](https://github.com/bafif/foja/blob/main/packages/core/schema/project.schema.json));
+styles of your own, written in Typst, are explained in
+[`docs/templates.md`](https://github.com/bafif/foja/blob/main/docs/templates.md).
+
+Licence: GPL-3.0. The bundled fonts keep their own licences (files next to them in
+`dist/template/fonts`).