Skip to content

Commit 231e9e7

Browse files
committed
🧹 reformat README
1 parent 2e10484 commit 231e9e7

File tree

1 file changed

+17
-14
lines changed

1 file changed

+17
-14
lines changed

README.md

Lines changed: 17 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ A CLI for converting graded [Moodle quizzes](https://docs.moodle.org/404/en/Quiz
1818

1919
## 📥 Installation
2020

21-
### ✨ Easy
21+
### 🌍 Global
2222

2323
1. [Install `pipx`](https://pipx.pypa.io/stable/#install-pipx)
2424
1. _If using Linux: [follow these steps](https://github.com/asweigart/pyperclip/blob/master/docs/index.rst#not-implemented-error)._
@@ -27,9 +27,11 @@ A CLI for converting graded [Moodle quizzes](https://docs.moodle.org/404/en/Quiz
2727
```bash
2828
pipx install moodle-to-vikwikiquiz
2929
```
30+
31+
### 🏠 Local
3032

3133

32-
### 🛠️ Executable `zipapp`
34+
#### 🛠️ Executable `zipapp`
3335

3436
1. Download the `.pyz` file of the latest release from [here](https://github.com/gy-mate/moodle-to-vikwikiquiz/releases/latest).
3537
1. Run the following commands in the terminal:
@@ -109,10 +111,22 @@ Run the following command in the terminal:
109111
vermin --backport argparse --backport enum --backport typing_extensions --eval-annotations .
110112
```
111113
112-
If it has changed, update [`pyproject.toml`](pyproject.toml) accordingly.
114+
If it has changed, please update [`pyproject.toml`](pyproject.toml) accordingly.
113115
114116
### 🏗️ Building
115117
118+
119+
- Repruducible `zipapp` (`.pyz`):
120+
1. [Install `pipx`](https://pipx.pypa.io/stable/#install-pipx)
121+
1. Install [`shiv`](https://github.com/linkedin/shiv):
122+
```bash
123+
pipx install shiv
124+
```
125+
1. Create the executable:
126+
```bash
127+
shiv --entry-point moodle_to_vikwikiquiz.main:main --output-file moodle-to-vikwikiquiz.pyz --reproducible .
128+
```
129+
1. _Optional: compare its hash with the one of the [latest release](https://github.com/gy-mate/moodle-to-vikwikiquiz/releases/)._
116130
- Wheels (`.whl`):
117131
1. Install `build`:
118132
```bash
@@ -124,17 +138,6 @@ If it has changed, update [`pyproject.toml`](pyproject.toml) accordingly.
124138
python3 -m build
125139
```
126140
127-
- `zipapp` (`.pyz`):
128-
1. [Install `pipx`](https://pipx.pypa.io/stable/#install-pipx)
129-
1. Install `shiv`:
130-
```bash
131-
pipx install shiv
132-
```
133-
1. Create the executable:
134-
```bash
135-
shiv --entry-point moodle_to_vikwikiquiz.main:main --output-file moodle-to-vikwikiquiz.pyz --reproducible .
136-
```
137-
138141
139142
## 📜 License
140143

0 commit comments

Comments
 (0)