Skip to content

Commit 19d652c

Browse files
committed
style: README updates
1 parent 8a1c82d commit 19d652c

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed

CONTRIBUTING.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,25 @@ Just use the this [web form](https://forms.gle/watgbhcDa5jkf85T7).
1111
`bibtex` entries are in `bbt.bib` while `biblatex` ones are in `biblatex.bib`. Please send all PRs for changes to both these files.
1212

1313
### Style
14-
- I prefer to edit using VSCode, keeping the bib file organized using [LaTeX Workshop's](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) "Align and sort bibliography".
14+
15+
- It's recommended to edit using VSCode, keeping the bib file organized using [LaTeX Workshop's](https://marketplace.visualstudio.com/items?itemName=James-Yu.latex-workshop) "Align and sort bibliography".
1516
- When sorting the fields of a bibentry, use the sorting order specified at the beginning of each `.bib` file. For mass sort, I have been using the `bibtex-tidy` tool at <https://flamingtempura.github.io/bibtex-tidy/>.
1617

1718
### Building and Testing (optional)
19+
1820
You **do not have to** test the website for contributing here, I have added the steps if you would like to, however. I will test the site for issues before I merge a PR.
1921

2022
#### Prerequisites
23+
2124
- For [retro](https://quantumpl.github.io/bib/retro/bbt.html) HTML generation: `bibtex2html`. Install the latest version using <https://github.com/backtracking/bibtex2html>
2225
- For website:
2326
- Go and a recent version of [`hugo_extended`](https://github.com/gohugoio/hugo/releases)
2427
- A local installation of `academic-cli` using the [qpl-bib](https://github.com/QuantumPL/academic-cli/tree/qpl-bib) branch:
2528
`git clone --single-branch --branch qpl-bib https://github.com/QuantumPL/academic-cli.git`
2629

2730
#### Local directory structure
28-
```
31+
32+
```sh
2933
$ tree -L 1 QuantumPL/
3034
QuantumPL/
3135
├── academic-cli
@@ -34,6 +38,7 @@ QuantumPL/
3438
```
3539

3640
#### Instructions
41+
3742
- If you'd also like to test the Hugo-based site:
3843
1. First ensure you have `academic-cli` ready using the instructions at <https://github.com/QuantumPL/academic-cli/tree/qpl-bib#contribute>
3944
2. Go to `site` and issue `./build.sh`

README.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
[![DOI](https://zenodo.org/badge/359320795.svg)](https://zenodo.org/badge/latestdoi/359320795)
2-
31
# QPL Bib
42

3+
[![DOI](https://zenodo.org/badge/359320795.svg)](https://zenodo.org/badge/latestdoi/359320795)
4+
55
A Quantum Programming Languages and Verification Literature Bibliography
66

77
See it rendered using `bibtex2html` at <https://quantumpl.github.io/bib/retro/bbt.html>
@@ -10,10 +10,12 @@ An alternate and more accessible rendering using `Hugo` at <https://quantumpl.gi
1010

1111
Hugo Source: <https://github.com/QuantumPL/site>
1212

13-
Corrections, additions, suggestions are all welcome! Please see [our contribution guide](./CONTRIBUTING.md).
13+
Corrections, additions, and suggestions are all welcome! Please see [our contribution guide](./CONTRIBUTING.md).
1414

1515
## Note
16+
1617
BibLaTeX validation can be done using:
17-
```
18+
19+
```sh
1820
biber --tool --no-default-datamodel --validate-datamodel --configfile=biber-tool.conf biblatex.bib
1921
```

0 commit comments

Comments
 (0)