Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
carueda committed May 3, 2020
1 parent 8deae46 commit b24eb89
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 8 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
MARS_20161221_000046_SongSession_16kHz_HPF5HzNorm_labels/
predictor*prd
predictor*txt
data/
/target
**/*.rs.bk
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,17 @@ with some functionality implemented in Rust.

## Installing and running

The `ecoz2` executable is available at https://github.com/ecoz2/ecoz2rs/releases
(only for Mac OS at the moment).

You can also install it if you have a C compiler and
You will need a gcc compiler and
[`Rust`](https://www.rust-lang.org/tools/install)
on your machine:

$ cargo install ecoz2

> If getting C compile errors, try `$ CC=c99 cargo install ecoz2`.

Running:

$ ecoz2 --help
ecoz2 0.1.1
$ ecoz2 help
ecoz2 0.3.0
ECOZ2 System

USAGE:
Expand All @@ -32,6 +28,7 @@ Running:

SUBCOMMANDS:
csv-show Basic csv selection info
cversion Show version of C code
help Prints this message or the help of the given subcommand(s)
hmm HMM operations
lpc Linear prediction coding
Expand All @@ -47,4 +44,4 @@ Running:
with selected functionality exposed via
https://doc.rust-lang.org/cargo/reference/build-scripts.html.

$ cargo build
$ cargo build [--release]

0 comments on commit b24eb89

Please sign in to comment.