Skip to content

[TM-71] Prettify README

Ivan Gromakovskii requested to merge gromak/tm71-prettify-readme into master

Description

Problem: usage instructions in README are a bit hard to read.

Solution: use nested markdown lists to make them more structured and readable.

Rendered

Related issue(s)

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

Checklist for your Merge Request

Related changes (conditional)

  • Tests

    • 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:

Stylistic guide (mandatory)

Edited by Ivan Gromakovskii

Merge request reports