Skip to content

Commit 119f224

Browse files
committed
Update README
1 parent ab19a07 commit 119f224

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,54 @@
1616
</p>
1717

1818
An open source scientific article created using the [showyourwork](https://github.com/showyourwork/showyourwork) workflow.
19+
20+
# Requirements
21+
22+
The only requirement is the Python package [showyourwork](https://show-your.work/en/latest/) and *git*.
23+
24+
> [!IMPORTANT]
25+
> The package is stable but still under development.
26+
> Depending when your cloned this repository, if you encounter some issue
27+
> try to install it from the latest commit on the stable branch with,
28+
> `pip install git+https://github.com/showyourwork/showyourwork.git`
29+
30+
How and where to install it will depend on your preferences, e.g.:
31+
32+
- use only your Python3 installation and the [`venv` Standard Library module](https://docs.python.org/3/tutorial/venv.html#creating-virtual-environments)
33+
- use [conda](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html)
34+
35+
Please, check [showyourwork docs](https://show-your.work/en/latest/) and its repository for
36+
documentation and help on any issue with it.
37+
38+
*showyourwork* uses [snakemake v7.15.2](https://snakemake.readthedocs.io/en/v7.15.2/) for defining
39+
a workflow.
40+
41+
# How to start a new project
42+
43+
You can start a new project by using this repository as a template.
44+
45+
Using the web page, click on the green button "Use this template" and then
46+
"Create a new repository".
47+
48+
See [GitHub Docs](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)
49+
for more details.
50+
51+
# How to reproduce results based on this template
52+
53+
After installing *showyourwork*, clone this repository with *git*,
54+
55+
`git clone https://github.com/YourUser/YourProjectName`
56+
57+
Enter in the new directory and run `showyourwork build`.
58+
59+
## Special requirements
60+
61+
*showyourwork* uses [tectonic](https://tectonic-typesetting.github.io/en-US/) as its typesetting system.
62+
63+
Currently *tectonic* uses a relatively old version of *biblatex*.
64+
If you need [biber](https://ctan.org/pkg/biber) to manage your bibliography, for the moment you have to use
65+
*biber v2.17*.
66+
67+
On macos you can install it with [Homebrew](https://brew.sh/)
68+
69+
`brew install dgfl-gh/taps/[email protected]`

0 commit comments

Comments
 (0)