mischbeck/ResearchManuscriptTemplate
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updates README.md

Browse Source
This commit is contained in:
Michael Beck
2026-07-02 10:11:49 +02:00
parent bd337d3512
commit aac9c6c869
1 changed files with 13 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+13 -7
View File
@@ -13,7 +13,13 @@ Make sure that Quarto, Task and Python are on your PATH.
## How to use ## How to use
Clone the repo and edit `*.qmd` files, update author information in `resources/author_profiles/_quarto-default.yml` include references in `resources/references.bib` and render all projects using `task finalize`. Clone the repo:
```bash
git clone https://git.mbeck.cologne/mischbeck/ScientificManuscriptTemplate
```
Edit `*.qmd` files, update author information in `resources/author_profiles/_quarto-default.yml` include references in `resources/references.bib` and render all projects using `task finalize`.
In any arch-based Linux distro, run `go-task finalize` instead. In any arch-based Linux distro, run `go-task finalize` instead.
@@ -21,7 +27,7 @@ More on how to include more detail in the front matter can be found in the offic
## Project layout ## Project layout
Each of `Manuscript/`, `ResearchReport/`, and `Supplements/` is its own Quarto project with its own `_quarto.yml`, `index.qmd`, `data/`, and `figures/` folders. Each of `Manuscript/`, `ResearchReport/`, and `Supplements/` contains a Quarto project with its own `_quarto.yml`, `index.qmd`, `data/`, and `figures/` folders.
``` ```
ScientificManuscriptTemplate/ ScientificManuscriptTemplate/
@@ -55,7 +61,7 @@ Each project has its own profile pair - `default` (real author info) and `anonym
**Render one project**, from inside that project's folder: **Render one project**, from inside that project's folder:
``` ```bash
cd Manuscript cd Manuscript
task render # default profile, all formats task render # default profile, all formats
task render:anonymized # anonymized profile, all formats task render:anonymized # anonymized profile, all formats
@@ -67,7 +73,7 @@ task render:jats
**Or run any project's task from the repo root**, using its namespace: **Or run any project's task from the repo root**, using its namespace:
``` ```bash
task manuscript:render task manuscript:render
task researchreport:render:anonymized task researchreport:render:anonymized
task supplements:render:docx task supplements:render:docx
@@ -75,14 +81,14 @@ task supplements:render:docx
**Render everything at once**, from the repo root: **Render everything at once**, from the repo root:
``` ```bash
task render:all # all three projects, default profile task render:all # all three projects, default profile
task render:all:anonymized # all three projects, anonymized profile task render:all:anonymized # all three projects, anonymized profile
``` ```
## Packaging and finalizing ## Packaging and finalizing
``` ```bash
task manuscript:package # zip Manuscript's default output task manuscript:package # zip Manuscript's default output
task manuscript:package:data # zip Manuscript/data into data.zip task manuscript:package:data # zip Manuscript/data into data.zip
task package:all # package every project, both profiles, plus data task package:all # package every project, both profiles, plus data
@@ -97,7 +103,7 @@ task finalize # render everything, package everything,
> [!WARNING] > [!WARNING]
> Be careful using this: the command also cleans caches, meaning that all computations will have to be re-evaluated. > Be careful using this: the command also cleans caches, meaning that all computations will have to be re-evaluated.
``` ```bash
task manuscript:clean # remove Manuscript's _output, .quarto, and stray cache folders task manuscript:clean # remove Manuscript's _output, .quarto, and stray cache folders
task clean:all # same, for all three projects task clean:all # same, for all three projects
``` ```