Skip to content

Commit

Permalink
Add physica-manual.pdf to repo for convience
Browse files Browse the repository at this point in the history
It's better that the link to the manual PDF in README.md is not
tied to the CI.
  • Loading branch information
Leedehai committed Sep 8, 2023
1 parent 5988611 commit 5802787
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[![CI](https://github.com/Leedehai/typst-physics/actions/workflows/ci.yml/badge.svg)](https://github.com/Leedehai/typst-physics/actions/workflows/ci.yml)
[![Latest release date](https://img.shields.io/github/release-date/Leedehai/typst-physics)][latest-release]

Current semantic version: `0.7`. [Manual][latest-manual].
Current semantic version: `0.7`. [Manual](physica-manual.pdf).

Available at [https://typst.app/docs/packages/](https://typst.app/docs/packages/).

Expand All @@ -27,7 +27,7 @@ everybody", this package was renamed from `physics` to `physica`.

## A quick look

See the [manual][latest-manual] for more details.
See the [manual](physica-manual.pdf) for more details.

![demo](https://user-images.githubusercontent.com/18319900/236073825-e91b4601-7e92-490b-a7e4-e9e405a2147b.png)

Expand Down Expand Up @@ -63,7 +63,7 @@ package under name scope `physica`:

## Manual

See the manual [physica-manual.pdf][latest-manual] for a more comprehensive coverage, a PDF file
See the manual [physica-manual.pdf](physica-manual.pdf) for a more comprehensive coverage, a PDF file
generated directly with the [Typst](https://typst.app) binary.

CLI Version:
Expand All @@ -88,7 +88,7 @@ request. If it is large, the best first step is creating an issue and let us
explore the design together. Some features might warrant a package on its own.

* Testing: currently testing is done by closely inspecting the generated
[physica-manual.pdf][latest-manual]. This does not scale well. I plan to add programmatic
[physica-manual.pdf](physica-manual.pdf). This does not scale well. I plan to add programmatic
testing by comparing rendered pictures with golden images.

## License
Expand Down
Binary file added physica-manual.pdf
Binary file not shown.

0 comments on commit 5802787

Please sign in to comment.