Merge pull request #242 from kmyk/docs

docs: Update docs/how-it-works.pdf
kmyk-jikka · Sep 29, 2021 · 6a19dd8 · 6a19dd8
2 parents 5cc2d76 + 92d0e95
commit 6a19dd8
Show file tree

Hide file tree

Showing 8 changed files with 899 additions and 517 deletions.
diff --git a/.github/workflows/format-tex.yaml b/.github/workflows/format-tex.yaml
@@ -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
diff --git a/README.md b/README.md
@@ -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 / 実装方針
@@ -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`)

diff --git a/docs/how-it-works.ja.pdf b/docs/how-it-works.ja.pdf
diff --git a/docs/how-it-works.ja.tex b/docs/how-it-works.ja.tex
diff --git a/docs/how-it-works.pdf b/docs/how-it-works.pdf
diff --git a/docs/how-it-works.tex b/docs/how-it-works.tex
diff --git a/docs/latexmkrc b/docs/latexmkrc
@@ -0,0 +1,2 @@
+$pdf_mode = 4;  # use lualatex
+$bibtex = 'pbibtex %O %B';  # for junsrt
diff --git a/scripts/pre-commit b/scripts/pre-commit
@@ -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