Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
87 lines (65 loc) · 2.41 KB

DEVELOPMENT.md

File metadata and controls

87 lines (65 loc) · 2.41 KB

Jak na vývoj

Instalace nástrojů

Budeme potřebovat:

  • git
  • python3 + pip (na Windows doporučuji z Win storu)

Repo

Naklonujeme si repozitář:

git clone https://github.com/RoboticsBrno/Robutek.git

nebo

git clone git@github.com:RoboticsBrno/Robutek.git

Konfigurace

Otevři projekt a v terminálu spusť:

pro linux a macos:

python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -r requirements.txt

pro windows CMD:

python3 -m venv .venv
./.venv/Scripts/Activate.bat
python3 -m pip install -r requirements.txt

pro windows Powershell:

python3 -m venv .venv
./.venv/Scripts/Activate.ps1
python3 -m pip install -r requirements.txt

Znovu otevření už nainstalovaných toolů (vscode to někdy dělá sám)

pro linux a macos:

source .venv/bin/activate

pro windows CMD:

./.venv/Scripts/Activate.bat

pro windows Powershell:

./.venv/Scripts/Activate.ps1

Práce s dokumentací

Lokální spuštění dokumentace:

  • pro v1 - python3 -m mkdocs serve --config-file mkdocs.v1.yml
  • pro v2 - python3 -m mkdocs serve --config-file mkdocs.v2.yml

Návody

  • Rozděleno do dvou složek docs/v1 a docs/v2 pro různé verze Robůtka, což znamená dva soubory konfigurace mkdocs - mkdocs.v1.yml a mkdocs.v2.yml
  • Do složek projektů není potřeba vkládat @types a src/libs, protože se kopírují automaticky z robutekLibrary
    • Spuštěním bash update-projects.sh se soubory automaticky nakopírují
    • Spuštěním bash jac-autocompile.sh se ve všech projektech spustí jac build

Práce s obrázky

Obrázky přidávej do podsložek v docs podle adresy stránky, na které se mají zobrazit. Uvnitř této stránky vytvoř složku assets-large a vlož do ní obrázky v plné velikosti.

Plugin mkdocs-resize-images automaticky rozpozná změny v adresáři assets-large a při buildu zmenší obrázky do požadované velikosti a uloží je do složky assets. Složka assets-large se neukládá do gitu, protože by byla zbytečně velká. Velké fotky si necháme jen lokálně a po dokončení návodu je můžete smazat.

Podporovené soubory jsou .jpg, .jpeg, .png, .gif, .svg.

Vychytávky

Pro více rozjetých dokumentací je možné použít --dev-addr 127.0.0.1:8001 pro specifikaci adresy a portu.