Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update docs/how-it-works.pdf #242

Merged
merged 5 commits into from
Sep 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions .github/workflows/format-tex.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: format-tex

on: [push, pull_request]

jobs:
format-tex:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2

- name: Install Dependencies
run: |
sudo apt install chktex

- name: Run chktex
run: |
chktex --nowarn={1,2,8,11,12,13,36,39} docs/*.tex
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,7 @@ For users:
For developpers:

- [CONTRIBUTING.md](https://github.com/kmyk/Jikka/blob/master/CONTRIBUTING.md)
- My blog article [競技プログラミングの問題を自動で解きたい - うさぎ小屋](https://kimiyuki.net/blog/2020/12/09/automated-solvers-of-competitive-programming/) (Japanese)
- On what it means to automatically solve problems of competitive programming / 競技プログラミングの問題を自動で解くとはどういうことなのかについて
- [docs/how-it-works.pdf](https://github.com/kmyk/Jikka/blob/master/docs/how-it-works.pdf) (Japanese)
- [docs/how-it-works.pdf](https://github.com/kmyk/Jikka/blob/master/docs/how-it-works.pdf) / [docs/how-it-works.ja.pdf](https://github.com/kmyk/Jikka/blob/master/docs/how-it-works.ja.pdf)
- How it works and related theories / 動作原理や関連する理論
- [docs/DESIGN.md](https://github.com/kmyk/Jikka/blob/master/docs/DESIGN.md)
- The policy of designs / 実装方針
Expand All @@ -80,6 +78,11 @@ For developpers:
- [Haddock](https://hackage.haskell.org/package/Jikka)
- [Haddock (master)](https://kmyk.github.io/Jikka/haddock)

Blog articles:

- [競技プログラミングの問題を自動で解きたい - うさぎ小屋](https://kimiyuki.net/blog/2020/12/09/automated-solvers-of-competitive-programming/) (Japanese)
- [Jikka, a transpiler/solver for competitive programming - Codeforces](https://codeforces.com/blog/entry/94648)

## Examples

### `examples/fib.py` (`v5.0.5.0`)
Expand Down
Binary file added docs/how-it-works.ja.pdf
Binary file not shown.
564 changes: 564 additions & 0 deletions docs/how-it-works.ja.tex

Large diffs are not rendered by default.

Binary file modified docs/how-it-works.pdf
Binary file not shown.
815 changes: 301 additions & 514 deletions docs/how-it-works.tex

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions docs/latexmkrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
$pdf_mode = 4; # use lualatex
$bibtex = 'pbibtex %O %B'; # for junsrt
8 changes: 8 additions & 0 deletions scripts/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,14 @@ if git diff --staged --name-only | grep '\.py$'; then
|| exit 1
fi

# TeX
if git diff --staged --name-only | grep '\.tex$'; then
chktex --version \
|| { echo HINT: Please install chktex, e.g. '$ sudo apt install chktex'; exit 1; }
chktex --nowarn={1,2,8,11,12,13,36,39} $(git ls-files | grep '\.tex$') \
|| exit 1
fi

# Other files
for ext in yml yaml json md html mjs; do
if git diff --staged --name-only | grep '\.'$ext'$'; then
Expand Down