diff options
author | Silvio Rhatto <rhatto@riseup.net> | 2024-06-06 16:11:29 -0300 |
---|---|---|
committer | Silvio Rhatto <rhatto@riseup.net> | 2024-06-06 16:11:29 -0300 |
commit | 29ed0857046640a08b3ac406609c962fecd6ae32 (patch) | |
tree | ce67b66704239c5169d03f6a7416762142b08024 | |
parent | ee44ef924874db42bd5d10b08d3b8f1f9f9de200 (diff) | |
download | bookup-29ed0857046640a08b3ac406609c962fecd6ae32.tar.gz bookup-29ed0857046640a08b3ac406609c962fecd6ae32.tar.bz2 |
Updates documentation
-rw-r--r-- | content/published/00-intro/intro.md | 20 | ||||
-rw-r--r-- | content/published/05-workflow/funcionamento.md | 9 | ||||
-rw-r--r-- | content/published/10-installation/installation.md | 16 | ||||
-rw-r--r-- | content/published/10-structure/structure.md (renamed from content/published/05-structure/structure.md) | 2 | ||||
-rw-r--r-- | content/published/15-installation/installation.md | 22 |
5 files changed, 46 insertions, 23 deletions
diff --git a/content/published/00-intro/intro.md b/content/published/00-intro/intro.md index 06e6fb4..5e5c7d0 100644 --- a/content/published/00-intro/intro.md +++ b/content/published/00-intro/intro.md @@ -1,11 +1,19 @@ # Introdução {#intro} -Criar Bookup ajudou a manter um esquema uniforme, ao invés de ter que -implementar e corrigir funcionalidades paralelamente em muitos repositórios, já -que os livros tendem a aumentar. Lidando com a produção de conteúdo como -lidamos com outros códigos, mas sem algoritmizar, ao contrário: usando um -processo arbóreo-espiral^[@TODO: definir o método arbóreo-espiral.]. +Bookup é um conjunto de templates, programas e fluxos de trabalho para a +autoria de livros em formatos HTML, PDF e EPUB. + +Ele é um componente de software modular baseado em [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. + +Com ele, a produção de conteúdo fica parecida com o trabalho com outros +códigos. 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 no futuro +importante foi criar uma base comum para os meus livros, e talvez aos poucos generalizar para que possa ser usado por outras iniciativas. + +[Bookdown]: https://bookdown.org diff --git a/content/published/05-workflow/funcionamento.md b/content/published/05-workflow/funcionamento.md new file mode 100644 index 0000000..66ff216 --- /dev/null +++ b/content/published/05-workflow/funcionamento.md @@ -0,0 +1,9 @@ +# Funcionamento {#funcionamento} + +Bookup opera através da _compilação_ de arquivos: + +``` + /--> Livro PDF +Arquivos fonte em Markdown --> Compilação --> + \--> Livro HTML +``` diff --git a/content/published/10-installation/installation.md b/content/published/10-installation/installation.md deleted file mode 100644 index b2e2392..0000000 --- a/content/published/10-installation/installation.md +++ /dev/null @@ -1,16 +0,0 @@ -# Instalação {#instalacao} - -Procedimento de instalação: - -* Vendorização (repositórios `bookup` e de bibliografia). -* Symlinking: - * `_bookdown.yml`. - * `output.yml`. -* Arquivos requeridos: - * `.gitignore`. - * `images/cover.png`. - * `_bookup.yml`. - * `_biblio.yml`. - * `LICENSE`. - * `DISCLAIMER`. - * `snippets/{contact,cover,keywords,project,url,volume}.txt`. diff --git a/content/published/05-structure/structure.md b/content/published/10-structure/structure.md index edc1884..f413396 100644 --- a/content/published/05-structure/structure.md +++ b/content/published/10-structure/structure.md @@ -1,6 +1,6 @@ # Estrutura de pastas {#estrutura} -A estrutura de pastas de um projeto usando Bookup: +A estrutura de pastas de um projeto usando Bookup é a seguinte: * `archive`: armazena versões antigas do livro. * `content`: o conteúdo do livro. diff --git a/content/published/15-installation/installation.md b/content/published/15-installation/installation.md new file mode 100644 index 0000000..9024b41 --- /dev/null +++ b/content/published/15-installation/installation.md @@ -0,0 +1,22 @@ +# Instalação {#instalacao} + +Procedimento de instalação do Bookup. + +## Vendorização + +* Vendorização (repositórios `bookup` e de bibliografia). + +## Links simbólicos + +* `_bookdown.yml`. +* `output.yml`. + +## Arquivos requeridos + +* `.gitignore`. +* `images/cover.png`. +* `_bookup.yml`. +* `_biblio.yml`. +* `LICENSE`. +* `DISCLAIMER`. +* `snippets/{contact,cover,keywords,project,url,volume}.txt`. |