Skip to content

Commit d2b4ccd

Browse files
authored
Update how to docs and Dockerfile (hellt#16)
1 parent b2d1490 commit d2b4ccd

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

Dockerfile

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ WORKDIR /app
44

55
COPY fnsort.py /app
66

7+
ENV PATH="${PATH}:/app"
8+
79
WORKDIR /work
810

9-
ENTRYPOINT ["python", "/app/fnsort.py"]
11+
ENTRYPOINT ["python", "/app/fnsort.py"]

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ https://github.com/user-attachments/assets/2ccb1782-1d85-499c-ba09-3be94c34a591
2828
1. Or download the script and put it in your `$PATH`:
2929

3030
```bash
31-
curl -sL https://raw.githubusercontent.com/hellt/markdown-footnote-sorter/main/fnsort.py
31+
curl -sL https://raw.githubusercontent.com/hellt/markdown-footnote-sorter/main/fnsort.py \
32+
> ~/.local/bin/fnsort.py
3233
3334
fnsort.py path/to/doc.md
3435
```
@@ -38,6 +39,10 @@ https://github.com/user-attachments/assets/2ccb1782-1d85-499c-ba09-3be94c34a591
3839
* Choose **Create codespace on <branch_name>** to [create a codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository) with the default resources (currently 2 CPU, 8 GB RAM, 32 GB Storage).
3940
<img alt="create codespace button" title="create codespace button" src="https://docs.github.com/assets/cb-49943/mw-1440/images/help/codespaces/who-will-pay.webp" width="275px"/>
4041
42+
```bash
43+
/app/fnsort.py path/to/doc.md
44+
```
45+
4146
> [!IMPORTANT]
4247
> Keep in mind there are [monthly limits measured in core hours](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#monthly-included-storage-and-core-hours-for-personal-accounts) and to [stop your codespace](https://docs.github.com/en/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace):stop_sign: when you're not using it to conserve your monthly core hours allowance.
4348

fnsort.py

100644100755
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#!/usr/bin/python3
1+
#!/usr/bin/env python3
22

33
"""
44
Read a Markdown file passed as a first argument and sort footnotes.

0 commit comments

Comments
 (0)