Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
55 lines (38 loc) · 950 Bytes

DEVELOPMENT.md

File metadata and controls

55 lines (38 loc) · 950 Bytes

Tikibase developer documentation

Setup your development machine

  1. Install openssl-devel:

    • Fedora: sudo dnf install openssl-devel
    • Debian: sudo apt install libssl-dev pkg-config

  2. run make setup

Run development scripts

See available development scripts:

make

Execute a development script:

make <name>

Examples:

make test
make fix

Run a single Cucumber scenario:

  • add a @this tag to the scenario
  • make cukethis

Debug the executable

  • check Cargo.toml and make sure the profile.dev section doesn't strip debug symbols
  • open file .vscode/launch.json
  • check the entry Debug executable 'tikibase'
    • args
    • cwd
  • switch VSCode to the Debug view
  • set a breakpoint
  • choose Debug executable 'tikibase'

Architecture