aboutsummaryrefslogtreecommitdiff
path: root/content
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-06-10 14:36:33 +0100
committerSilvio Rhatto <rhatto@riseup.net>2024-06-10 14:36:33 +0100
commit04e564ce64f1be448cd6b42912dd302c6c9089d0 (patch)
tree29ff70879e71a6c79355d05b3b0e724b372d1ff6 /content
parent4f568ab53f2df5a903dfa0131b277fb4b020125f (diff)
downloadbookup-04e564ce64f1be448cd6b42912dd302c6c9089d0.tar.gz
bookup-04e564ce64f1be448cd6b42912dd302c6c9089d0.tar.bz2
Feat: docs: translate to english
Diffstat (limited to 'content')
-rw-r--r--content/notes/00-intro/notes.md4
-rw-r--r--content/sections/00-intro/intro.md25
-rw-r--r--content/sections/05-workflow/funcionamento.md14
-rw-r--r--content/sections/10-structure/structure.md38
-rw-r--r--content/sections/15-installation/installation.md14
5 files changed, 47 insertions, 48 deletions
diff --git a/content/notes/00-intro/notes.md b/content/notes/00-intro/notes.md
index 518cdab..7f5a57e 100644
--- a/content/notes/00-intro/notes.md
+++ b/content/notes/00-intro/notes.md
@@ -1,3 +1,3 @@
-# Caderno de anotações {#anotacoes .unnumbered}
+# Notebook {#anotacoes .unnumbered}
-Exemplo de caderno de anotações.
+Notebook example.
diff --git a/content/sections/00-intro/intro.md b/content/sections/00-intro/intro.md
index c32674c..2fa235b 100644
--- a/content/sections/00-intro/intro.md
+++ b/content/sections/00-intro/intro.md
@@ -1,22 +1,21 @@
-# Introdução {#intro}
+# Introduction {#intro}
-Bookup^[@bookup] é um conjunto de templates, programas e fluxos de trabalho
-para a autoria de livros em formatos HTML, PDF e EPUB.
+Bookup^[@bookup] is a set of templates, scripts and workflows for book
+authoring in HTML, PDF and other formats.
-Ele é um componente de software modular baseado em [Bookdown][].
+It's a modular software component based on [Bookdown][].
-Foi criado para resolver o problema de editar muitos livros simultaneamente:
-Bookup ajuda a manter um esquema uniforme, ao invés de ter que implementar e
-corrigir funcionalidades paralelamente em muitos repositórios.
+It was created to solve the problem of editing many books simultaneously:
+Bookup helps to keep an uniform scheme instead of having to implement and fix
+funcionalities across many repositories in parallel.
-Com ele, a produção de conteúdo fica parecida com o trabalho com outros
-códigos.
+[Bookup][] makes book production similar to working with other codebases.
-Não foi priorizado investir tempo em generalizar tudo ao máximo. O mais
-importante foi criar uma base comum para os meus livros, e talvez aos poucos
-generalizar para que possa ser usado por outras iniciativas.
+But [Bookup][] is very opinionated.
+You can understand it as an specific setup of [Bookdown][] and other software,
+plus conventions and heuristics tuned to an specific use case.
-O código do Bookup está disponível em [https://0xacab.org/rhatto/bookup][].
+[Bookup][] code is available at [https://0xacab.org/rhatto/bookup][].
[Bookdown]: https://bookdown.org
[https://0xacab.org/rhatto/bookup]: https://0xacab.org/rhatto/bookup
diff --git a/content/sections/05-workflow/funcionamento.md b/content/sections/05-workflow/funcionamento.md
index b3ce0fe..16f0c72 100644
--- a/content/sections/05-workflow/funcionamento.md
+++ b/content/sections/05-workflow/funcionamento.md
@@ -1,11 +1,11 @@
-# Funcionamento {#funcionamento}
+# Workflow {#workflow}
-Bookup opera através da _compilação_ de arquivos:
+Bookup works through _compiling_ files from source:
```
- \ .--> Livro PDF
-Layout (LaTeX e HTML) \ /
-Texto fonte (Markdown) >---> Compilação ----<
-Bibliografia (BibTeX) / \
- / `--> Livro HTML
+ \ .--> PDF book
+Layout (LaTeX and HTML) \ /
+Source text (Markdown) >---> Compilation ----<
+Bibliography (BibTeX) / \
+ / `--> HTML book
```
diff --git a/content/sections/10-structure/structure.md b/content/sections/10-structure/structure.md
index 98b2f91..f43dc4a 100644
--- a/content/sections/10-structure/structure.md
+++ b/content/sections/10-structure/structure.md
@@ -1,21 +1,21 @@
-# Estrutura de pastas {#estrutura}
+# Folder structure {#structure}
-A estrutura de pastas de um projeto usando Bookup é a seguinte:
+A Bookup project folder structure looks like this:
-* `archive`: armazena versões antigas do livro.
-* `content`: o conteúdo do livro.
- * `drafts`: deixe aqui os textos que ainda estão em composição.
- * `sections`: aqui vai todo o material a ser compilado em livro.
- * `notes`: caderno de anotações a ser incluído no material público.
-* `slides`: slides no formato Markdown.
-* `site`: HTML opcional usado para o sítio base; se existir, o livro será
- colocado dentro da pasta `public/book` ou algo assim.
-* `build`: o livro compilado (HTML, PDF e outros formatos):
- * `notes`: caderno de notas compilado.
- * `book`: o livro compilado, se houver uma pasta `site`, caso contrário o
- conteúdo dolivro será colocado na pasta raíz do diretório `public`.
-* `biblio`: bibliografia.
-* `images`: pasta de imagens.
-* `vendor/bookup`:
- * `content`: documentação do Bookup.
- * `vendor/{Fuse.js,}`: dependências.
+* `archive`: stores old book versions.
+* `content`: the actual content:
+ * `drafts`: you can leave here texts still being composed.
+ * `sections`: here goes the material to be compiled in book format.
+ * `notes`: keep texts here to be compiled as a notebook companion.
+* `slides`: slides in Markdown format.
+* `site`: an optional website used as base; if that exists, the book will be
+ place inside the `build/book` folder.
+* `build`: the compiled book (HTML, PDF and other formats):
+ * `notes`: the compiled notebook.
+ * `book`: the compiled book, if there's a `site` folder available,
+ otherwise the book content will be placed in the toplevel `build` folder.
+* `biblio`: bibliography (BibTeX).
+* `images`: image folder.
+* `vendor/bookup`: where the Bookup codebase actually resides:
+ * `content`: Bookup documentation.
+ * `vendor/{Fuse.js,}`: dependencies.
diff --git a/content/sections/15-installation/installation.md b/content/sections/15-installation/installation.md
index 810e30f..44445c5 100644
--- a/content/sections/15-installation/installation.md
+++ b/content/sections/15-installation/installation.md
@@ -1,24 +1,24 @@
-# Instalação {#instalacao}
+# Installation {#installation}
-Procedimento de instalação do Bookup.
+Bookup installation procedure.
-## Vendorização
+## Vendorization
-* Vendorização (repositórios `bookup` e de bibliografia).
+* Vendorization (`bookup` and bibliography repositories).
-## Links simbólicos
+## Symbolic links
* `_bookdown.yml`.
* `output.yml`.
-## Arquivos requeridos
+## Requiser files
* `.gitignore`.
-* `images/cover.png`.
* `_common.yml`.
* `_book.yml`.
* `_notes.yml`.
* `_biblio.yml`.
* `LICENSE`.
* `DISCLAIMER`.
+* `images/cover.png`.
* `snippets/{contact,cover,keywords,project,url,volume}.txt`.