From 864b4ed2b6f1c9bf841df6badc516ee5960761b4 Mon Sep 17 00:00:00 2001 From: Lizzie Crowdagger Date: Sun, 6 Aug 2023 23:21:29 +0200 Subject: [PATCH 01/28] Update README.md --- .github/worflows/main.yml | 14 ++++++++++++++ README.md | 23 +++-------------------- 2 files changed, 17 insertions(+), 20 deletions(-) create mode 100644 .github/worflows/main.yml diff --git a/.github/worflows/main.yml b/.github/worflows/main.yml new file mode 100644 index 0000000..7cdc904 --- /dev/null +++ b/.github/worflows/main.yml @@ -0,0 +1,14 @@ +on: + push: + branches: + - main + +jobs: + contrib-readme-job: + runs-on: ubuntu-latest + name: A job to automate contrib in readme + steps: + - name: Contribute List + uses: akhilmhdh/contributors-readme-action@v2.3.6 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/README.md b/README.md index 8fdf8fe..e0b5553 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ # Crowbook -[![Travis status](https://travis-ci.org/lise-henry/crowbook.svg?branch=master)](https://travis-ci.org/lise-henry/crowbook) -[![Appveyor status](https://ci.appveyor.com/api/projects/status/bnj1rg76khth0aia?svg=true)](https://ci.appveyor.com/project/lise-henry/crowbook) - Crowbook's aim is to allow you to write a book in Markdown without worrying about formatting or typography, and let the program generate HTML, PDF and EPUB output for you. Its focus is novels and fiction, and the default settings should (hopefully) generate readable books with correct typography without requiring you to worry about it. @@ -23,14 +20,11 @@ either using precompiled binaries, or compiling it using `cargo`. See [the releases page](https://github.com/lise-henry/crowbook/releases) -to download a precompiled binary for your architecture -(currently: Linux, Windows and MacOSX). +to download a precompiled binary for your architecture. Just extract the archive and run `crowbook` (or `crowbook.exe` on Windows). You might also want to copy the binary somewhere in your `PATH` for later usage. -If you are on Debian GNU/Linux or Ubuntu (on a PC architecture), you can also download `.deb` packages on -[the releases page](https://github.com/lise-henry/crowbook/releases). ### Using Cargo @@ -52,16 +46,11 @@ compile it, and install it on your system. > Some dependencies also require building C libraries; > you might thus also need to install a C compiler and `make`/`cmake` build tools. -> You can also try to build a version of Crowbook without optional features: -> `cargo install crowbook --no-default-features --features "clap"` -> will disable syntactic highlighting and proofreading, requiring less dependencies. ## Dependencies -While there should be, strictly speaking, no real dependencies to be able to run Crowbook (it is published as a statically compiled binary), some features require additional commands to work correctly: - -* EPUB rendering requires the `zip` command to be present on your system; -* PDF rendering requires a working installation of LaTeX (preferably `xelatex`). +While there should be, strictly speaking, no real dependencies to be able to run Crowbook (it is published as a statically compiled binary), +PDF rendering requires a working installation of LaTeX (preferably `xelatex`). ## Quick tour @@ -141,12 +130,6 @@ title: My title This is mostly useful when Crowbook is run with the `--single` argument (receiving a single Markdown file instead of a book configuration file), for short texts that only contain one "chapter". -### Proofreading - -Crowbook can also generate "proofreading" copies in HTML or PDF, highlighting grammar errors and repetitions. -For more information, see -[the proofreading chapter of the guide](guide/05_proofreading.md). - ### Interactive fiction Crowbook has experimental support for writing interactive fiction (only for HTML). From 759e8785e9fbf4feff4a0bbdc8d6ee835aff591a Mon Sep 17 00:00:00 2001 From: Lizzie Crowdagger Date: Sun, 6 Aug 2023 23:22:12 +0200 Subject: [PATCH 02/28] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index e0b5553..b209a12 100644 --- a/README.md +++ b/README.md @@ -148,8 +148,8 @@ See the ## Contributors -* [Stéphane Mourey](http://stephanemourey.fr/) `` -* [Falco Hirschenberger](https://github.com/hirschenberger) + + ## Acknowledgements From 0a70dd682b9c919a111855b0e7cce45ee3591528 Mon Sep 17 00:00:00 2001 From: Lizzie Crowdagger Date: Mon, 7 Aug 2023 01:02:29 +0200 Subject: [PATCH 03/28] Add Funding.yml --- .github/FUNDING.yml | 1 + 1 file changed, 1 insertion(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..a797ade --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1 @@ +github: [lise-henry] \ No newline at end of file From 91b63fae8950235d78e5139252b8457f1d70607a Mon Sep 17 00:00:00 2001 From: Lizzie Crowdagger Date: Mon, 7 Aug 2023 01:36:27 +0200 Subject: [PATCH 04/28] Remove references to proofreading --- guide.book | 1 - guide/01_arguments.md | 17 ----------------- 2 files changed, 18 deletions(-) diff --git a/guide.book b/guide.book index 046cfe3..170653c 100644 --- a/guide.book +++ b/guide.book @@ -74,7 +74,6 @@ epub.version: 3 + guide/02_config.md + guide/03_markdown.md + guide/04_templates.md -+ guide/05_proofreading.md + guide/06_interactive_fiction.md + guide/07_miscellaneous.md + guide/08_contributing.md diff --git a/guide/01_arguments.md b/guide/01_arguments.md index db3cce5..5e1dc03 100644 --- a/guide/01_arguments.md +++ b/guide/01_arguments.md @@ -182,23 +182,6 @@ crowbook -S Display some statistics (word and character counts) about the book. -## `--proofread` - -**Usage**: - -```bash -crowbook --proofread -``` - -or: - -```bash -crowbook -p -``` - -Equivalent to `--set proofread true`, enables proofreading. -See [Proofreading](05_proofreading.md). - ## `--autograph` **Usage**: From 8232988cae20d0e89119396d7af6683a3635015d Mon Sep 17 00:00:00 2001 From: Lise Henry Date: Mon, 7 Aug 2023 01:42:35 +0200 Subject: [PATCH 05/28] Remove reference to ODT output --- guide/02_config.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/guide/02_config.md b/guide/02_config.md index 2f67434..ddde66d 100644 --- a/guide/02_config.md +++ b/guide/02_config.md @@ -299,11 +299,6 @@ Current output options are: * `output.tex`: renders a LaTeX file. * `output.pdf`: renders a PDF file (using `tex.command`). -(There are other output options for generating proofreading files, see -[Proofreading](05_proofreading.md), -and interactive fiction, see -[Interactive fiction](06_interactive_fiction.md).) - #### The `output` option Setting output file names manually can be a bit tedious, and is not always necessary. @@ -643,12 +638,6 @@ The `path` type might puzzle you a bit, but it's equivalent to a string, except - **default value**: `not set` - Output file name for PDF rendering -#### `output.odt` - -- **type**: path -- **default value**: `not set` -- Output file name for ODT rendering - #### `output.html.if` - **type**: path From d23cbd5d3f2ef36ef2a41bd830372601e5b04547 Mon Sep 17 00:00:00 2001 From: Lise Henry Date: Mon, 7 Aug 2023 01:59:42 +0200 Subject: [PATCH 06/28] Try to get contributors-readme-action to work --- .github/worflows/main.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/worflows/main.yml b/.github/worflows/main.yml index 7cdc904..e1da4c8 100644 --- a/.github/worflows/main.yml +++ b/.github/worflows/main.yml @@ -10,5 +10,7 @@ jobs: steps: - name: Contribute List uses: akhilmhdh/contributors-readme-action@v2.3.6 + with: + readme_path: "README.md" env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file From 327e7156a66536f94ecc2b6220a4f608e0640548 Mon Sep 17 00:00:00 2001 From: Lise Henry Date: Mon, 7 Aug 2023 02:05:26 +0200 Subject: [PATCH 07/28] =?UTF-8?q?Fix=20typo=20in=20workflows=20gosh=20I?= =?UTF-8?q?=E2=80=99m=20so=20STUPID?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/{worflows => workflows}/main.yml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/{worflows => workflows}/main.yml (100%) diff --git a/.github/worflows/main.yml b/.github/workflows/main.yml similarity index 100% rename from .github/worflows/main.yml rename to .github/workflows/main.yml From 74fc9610334a5d1fd9d6d382cc1313f1d7406244 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 7 Aug 2023 00:05:49 +0000 Subject: [PATCH 08/28] docs(contributor): contrib-readme-action has updated readme --- README.md | 124 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 124 insertions(+) diff --git a/README.md b/README.md index b209a12..37b5210 100644 --- a/README.md +++ b/README.md @@ -149,6 +149,130 @@ See the ## Contributors + + + + + + + + + + + + + + + + + + + + + +
+ + lise-henry +
+ Élisabeth Henry + + 		+ + Crowdagger +
+ Lizzie Crowdagger + + 		+ + stefan0xC +
+ Stefan Melmuk + + 		+ + hirschenberger +
+ Falco Hirschenberger + + 		+ + Geobert +
+ Geobert Quach + + 		+ + jrappen +
+ Johannes Rappen + +
+ + taophp +
+ Stéphane Mourey + + 		+ + dkotrada +
+ Alfa + + 		+ + hfiguiere +
+ Hubert Figuière + + 		+ + dvalter +
+ Dmitry Valter + + 		+ + Dylan-DPC +
+ Dylan DPC + + 		+ + steffahn +
+ Frank Steffahn + +
+ + cuviper +
+ Josh Stone + + 		+ + mgeisler +
+ Martin Geisler + + 		+ + sigurdsvela +
+ Sigurd Svela + + 		+ + twirrim +
+ Twirrim + + 		+ + ar1ocker +
+ Ar1oc + +
## Acknowledgements From 5d12cd80b11bfb9985fe2f4e52a44d0f2238c4bb Mon Sep 17 00:00:00 2001 From: Lise Henry Date: Mon, 7 Aug 2023 14:25:43 +0200 Subject: [PATCH 09/28] Remove proofread-related code --- src/lib/book.rs | 175 +----------------------------------------------- 1 file changed, 1 insertion(+), 174 deletions(-) diff --git a/src/lib/book.rs b/src/lib/book.rs index ae0b39a..a62e7d5 100644 --- a/src/lib/book.rs +++ b/src/lib/book.rs @@ -1,4 +1,4 @@ -// Copyright (C) 2016, 2017, 2018 Élisabeth HENRY. +// Copyright (C) 2016-2023 Élisabeth HENRY. // // This file is part of Crowbook. // @@ -29,8 +29,6 @@ use crate::lang; use crate::latex::{Latex, Pdf, ProofLatex, ProofPdf}; use crate::misc; use crate::number::Number; -#[cfg(feature = "odt")] -use crate::odt::Odt; use crate::parser::Features; use crate::parser::Parser; use crate::resource_handler::ResourceHandler; @@ -38,40 +36,6 @@ use crate::templates::{epub, epub3, highlight, html, html_dir, html_if, html_sin use crate::text_view::view_as_text; use crate::token::Token; -#[cfg(feature = "proofread")] -use crate::grammalecte::GrammalecteChecker; -#[cfg(feature = "proofread")] -use crate::grammar_check::GrammarChecker; -#[cfg(feature = "proofread")] -use crate::repetition_check::RepetitionDetector; -// Dummy grammarchecker thas does nothing to let the compiler compile -#[cfg(not(feature = "proofread"))] -struct GrammarChecker {} -#[cfg(not(feature = "proofread"))] -impl GrammarChecker { - fn check_chapter(&self, _: &[Token]) -> Result<()> { - Ok(()) - } -} -// Dummy grammalectechecker thas does nothing to let the compiler compile -#[cfg(not(feature = "proofread"))] -struct GrammalecteChecker {} -#[cfg(not(feature = "proofread"))] -impl GrammalecteChecker { - fn check_chapter(&self, _: &[Token]) -> Result<()> { - Ok(()) - } -} -// Dummy RepetitionDetector thas does nothing to let the compiler compile -#[cfg(not(feature = "proofread"))] -struct RepetitionDetector {} -#[cfg(not(feature = "proofread"))] -impl RepetitionDetector { - fn check_chapter(&self, _: &[Token]) -> Result<()> { - Ok(()) - } -} - use std::borrow::Cow; use std::cmp::Ordering; use std::collections::HashMap; @@ -179,9 +143,6 @@ pub struct Book { cleaner: Box, chapter_template: Option