Skip to content

[TM-245] Update README in lorentz package

Roman Melnikov requested to merge rvem/tm245-lorentz-doc into master

Description

Problem: Readme in lorentz package is not really informative.

Solution: Add FAQ to it, also add section about writing contracts in Lorentz listing main language features and provide examples for them.

Related issue(s)

https://issues.serokell.io/issue/TM-245

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated changelog files of all affected packages released to Hackage if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Roman Melnikov

Merge request reports