Schnelleinstieg

.. first-steps::

Installation

1. Herunterladen und auspacken:

   … auf Linux/macOS:

   $ curl -O https://github.com/cusyio/cusy-design-system/archive/refs/heads/main.zip
   $ unzip cusy-design-system-main.zip
   Archive:  cusy-design-system-main.zip
   …
      creating: cusy-design-system-main/
   …

   … auf Windows:

   C:> curl.exe -o main.zip -O https://github.com/cusyio/cusy-design-system/archive/refs/heads/main.zip
   C:> tar -xvzf cusy-design-system-main.zip
   …
   

2. Installieren von Python-Paketen:

   … auf Linux/macOS:

   $ python3 -m venv .venv
   $ . .venv/bin/activate
   $ python -m pip install -e ".[dev]"

   … auf Windows:

   C:> py -m venv .venv
   C:> Scripts\activate
   C:> python -m pip install -e ".[dev]"
   

3. Erstellen der HTML-Dokumentation:

   Note

   pandoc muss installiert sein.

   … auf Debian/Ubuntu:

   $  sudo apt install pandoc

   Zum Erstellen der HTML-Dokumentation führt den folgenden Befehl aus:

   $ python -m sphinx -b html docs/ docs/_build/html/

4. Erstellen eines PDF:

   Zum Erstellen einer PDF-Dokumentation benötigt ihr zusätzliche Pakete, die ihr installieren könnt

   … auf Debian/Ubuntu mit

   $ sudo apt install texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended latexmk

   … auf macOS mit

   $ brew cask install mactex
   …
   🍺  mactex was successfully installed!
   $ curl --remote-name https://www.tug.org/fonts/getnonfreefonts/install-getnonfreefonts
   $ sudo texlua install-getnonfreefonts
   …
   mktexlsr: Updating /usr/local/texlive/2020/texmf-dist/ls-R...
   mktexlsr: Done.

   Anschließend könnt ihr ein PDF generieren mit:

   $ . .venv/bin/activate
   $ cd docs/
   $ make latexpdf
   …
   The LaTeX files are in _build/latex.
   Run 'make' in that directory to run these through (pdf)latex
   …

   Das PDF findet ihr dann in _build/latex/cusy-design-system.pdf.

Folge uns

• GitHub
• Mastodon

Pull-Requests

Wenn ihr Vorschläge für Verbesserungen und Ergänzungen habt, empfehle ich euch, einen Fork meines GitHub-Repository zu erstellen und darin eure Änderungen vorzunehmen. Gerne dürft ihr auch einen Pull Request stellen. Sofern die darin enthaltenen Änderungen klein und atomar sind, schaue ich mir eure Vorschläge gerne an.