-
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9ddc615
commit 3df49ea
Showing
1 changed file
with
5 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,11 @@ | ||
# EuneusBench | ||
|
||
**TODO: Add description** | ||
An Elixir project to run benchmarks. | ||
|
||
## Installation | ||
## Directory structure | ||
|
||
If [available in Hex](https://hex.pm/docs/publish), the package can be installed | ||
by adding `euneus_bench` to your list of dependencies in `mix.exs`: | ||
The scripts are in the `./script` folder and the JSON files are in `./priv/data`. | ||
|
||
```elixir | ||
def deps do | ||
[ | ||
{:euneus_bench, "~> 0.1.0"} | ||
] | ||
end | ||
``` | ||
|
||
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) | ||
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can | ||
be found at <https://hexdocs.pm/euneus_bench>. | ||
## Running the scripts | ||
|
||
Run the encode benchmark in the command line via `$ mix encode` and decode via `$ mix decode`. |