greg/mentat
1
0
Fork 0
Code Issues 294 Pull requests Projects Releases 9 Packages Wiki Activity

Update README with extra details about using cargo

Browse source
This commit is contained in:
Brian Grinstead 2016-12-16 18:45:44 -08:00 committed by GitHub
parent 9b8257a725
commit 4700eace15
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -50,7 +50,6 @@ SQLite is a traditional SQL database in most respects: schemas conflate semantic
Datomish aims to offer many of the advantages of SQLite — single-file use, embeddability, and good performance — while building a more relaxed and expressive data model on top. Datomish aims to offer many of the advantages of SQLite — single-file use, embeddability, and good performance — while building a more relaxed and expressive data model on top.
## Contributing ## Contributing
Please note that this project is released with a Contributor Code of Conduct. Please note that this project is released with a Contributor Code of Conduct.
@ -66,7 +65,7 @@ contribute.
Right now this code is located on a branch, so you first need to `git checkout rust`. To build and test the project, we are using [Cargo](https://crates.io/install). Right now this code is located on a branch, so you first need to `git checkout rust`. To build and test the project, we are using [Cargo](https://crates.io/install).
To build use To build all of the crates in the project use:
```` ````
cargo build cargo build
@ -75,15 +74,21 @@ cargo build
To run tests use: To run tests use:
```` ````
# Run tests for the core code (src/)
cargo test cargo test
# Run tests for the query-parser folder
cargo test -p datomish-query-parser
```` ````
To run the cli use: To start the cli use:
```` ````
cargo run cargo run
```` ````
For most `cargo` commands you can pass the `-p` argument to run the command just on that package. By convention, the package name will be "datomish-directory-name". So, `cargo build -p datomish-cli` will build just the "cli" folder.
## License ## License
Datomish is currently licensed under the Apache License v2.0. See the `LICENSE` file for details. Datomish is currently licensed under the Apache License v2.0. See the `LICENSE` file for details.
@ -94,4 +99,3 @@ Datomish is currently licensed under the Apache License v2.0. See the `LICENSE`
Datomish uses partial indices, which are available in SQLite 3.8.0 and higher. Datomish uses partial indices, which are available in SQLite 3.8.0 and higher.
It also uses FTS4, which is [a compile time option](http://www.sqlite.org/fts3.html#section_2). It also uses FTS4, which is [a compile time option](http://www.sqlite.org/fts3.html#section_2).