Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roy-ganz/toql_guide

User guide for Toql
https://github.com/roy-ganz/toql_guide

Last synced: 6 days ago
JSON representation

User guide for Toql

Awesome Lists containing this project

README

        

# Guide for Toql 0.4

This is the user guide for [Toql](https://docs.rs/toql/0.4/toql/), an ORM for the Rust programming language.

The guide is published on a [GitHub Page]( https://roy-ganz.github.io/toql_guide/).

## Build

This guide uses [mdBook](https://github.com/rust-lang/mdBook).

To build the `/src` folder and put the guide into `/docs` run:

```bash
mdbook build
```

If you want to see the output after the build call with `--open` option.

## Test

The examples in the guide can be tested with

```bash
cargo test --doc
```

## License
Toql guide is distributed under the terms of both the MIT license and the
Apache License (Version 2.0).