Merge pull request #142 from gi-ev/refine-docs

Refine README.md

.github/workflows/check.yml

@@ -19,8 +19,6 @@ jobs:
     steps:
       - name: Check out code
         uses: actions/checkout@v4
-        with:
-          show-progress: ''
       - name: Install TeX Live
         uses: zauguin/install-texlive@v3
         with:
@@ -35,18 +33,19 @@ jobs:
     steps:
       - name: Check out code
         uses: actions/checkout@v4
-        with:
-          show-progress: ''
+
       - name: Install TeX Live
         uses: zauguin/install-texlive@v3
         with:
            package_file: Texlivefile
+
       - name: Generate lni.cls, *.tex, ...
         run: |
           pdflatex lni.ins
           pdflatex lni.dtx
           pdflatex lni.dtx
           pdflatex lni.dtx
+
       - name: Check for modifications
         run: |
           git update-index --refresh
@@ -84,7 +83,6 @@ jobs:
         run: |
           set -e
           mkdir /tmp/gh-pages
-          cp README.md /tmp/gh-pages/index.md
           cp *.pdf /tmp/gh-pages
 
       - name: Deploy to GH pages
@@ -93,6 +91,7 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: /tmp/gh-pages
+          force_orphan: true
 
       - name: Install dependencies for ctanify
         if: matrix.engine != 'lualatex'
@@ -117,8 +116,6 @@ jobs:
     steps:
       - name: Check out code
         uses: actions/checkout@v4
-        with:
-          show-progress: ''
       - uses: jbangdev/[email protected]
         with:
           script: com.github.nbbrd.heylogs:heylogs-cli:0.7.2:bin

README.md

@@ -1,4 +1,4 @@
-# lni
+# lni - LaTeX class for submissions to the ``Lecture Notes in Informatics''
 
 ```yaml
 ----------------------------------------------------------------------------
@@ -15,28 +15,35 @@ See:        https://www.latex-project.org/lppl/
 This is the official version of the class “lni” for submissions to the
 “[Lecture Notes in Informatics]” published by the “Gesellschaft für Informatik”
 ([GI]).
-
 It is based on previous templates created on behalf of the GI.
 
-Quick start:
-Download [`lni-author-template.tex`](lni-author-template.tex) and edit it in
-your favorite LaTeX editor.
+## Quick start
+
+Download [`lni-author-template.tex`](https://github.com/gi-ev/LNI/blob/main/lni-author-template.tex) and edit it in your favorite LaTeX editor.
+
+## Improved usage
+
 By default [BibTeX](https://www.ctan.org/pkg/bibtex) is used as bibliography tool.
-In case you want to use [biblatex](https://www.ctan.org/pkg/biblatex) together with
-[Biber](https://www.ctan.org/pkg/biber) (strongly recommended), read on in the
-documentation. There is a specialized package
-[biblatex-lni](https://ctan.org/pkg/biblatex-lni), which can easily be included
-to get correctly formed bibliographies. The easiest way is to add `biblatex` as class
-option. See documentation for details.
+In case you want to use [biblatex](https://www.ctan.org/pkg/biblatex) together with [Biber](https://www.ctan.org/pkg/biber) (strongly recommended), use the specialized package [biblatex-lni](https://ctan.org/pkg/biblatex-lni).
+The easiest way is to add `biblatex` as class option - or to directly start at `lni-paper-example-de.tex`.
 
-You should use `pdflatex` as `xelatex` and `lualatex` lack some features of the class file.
+## Links
 
-Stable versions are always uploaded to CTAN and available at <https://www.ctan.org/pkg/lni>.
-In addition, you will find the most recent developer version on GitHub at https://github.com/gi-ev/lni.
-The most recent documentation is available at <https://gi-ev.github.io/LNI/lni.pdf>.
-It includes a short description how to use the template and also provides troubleshooting hints.
+- Documentation: [`lni.pdf`](https://gi-ev.github.io/LNI/lni.pdf). It includes a short description how to use the template and also provides troubleshooting hints.
+- Changes: [`CHANGELOG.md`](https://github.com/gi-ev/LNI/blob/main/CHANGELOG.md#changelog) for a version history.
+- Stable versions: Always uploaded to CTAN and available at <https://www.ctan.org/pkg/lni>.
+- Developer repository: <https://github.com/gi-ev/LNI>
 
-Please see [`CHANGELOG.md`](CHANGELOG.md) for a version history
+The following links are based on the current development state:
+
+- Longer German paper example: [`lni-paper-example-de.tex`](https://github.com/gi-ev/LNI/blob/main/lni-paper-example-de.tex).
+  You will also need [`lni-paper-example-de.bib`](https://github.com/gi-ev/LNI/blob/main/lni-paper-example-de.bib).
+  The PDF is available at [`lni-paper-example-de.pdf`](https://gi-ev.github.io/LNI/lni-paper-example-de.pdf).
+- Rendered `lni-author-template.tex`: [`lni-author-template.pdf`](https://gi-ev.github.io/LNI/lni-author-template.pdf).
+
+## Note
+
+You should use `pdflatex` as `xelatex` and `lualatex` lack some features of the class file.
 
 [GI]: https://gi.de/
 [Lecture Notes in Informatics]: https://gi.de/service/publikationen/lni