1
- # Glychee · A Simple Gleam Benchmark Runner on Erlang via Benchee
1
+ # Glychee · A Simple Gleam Benchmark Runner on Erlang via Elixir's Benchee
2
2
3
3
[ ![ Hex Package] ( https://img.shields.io/hexpm/v/glychee?color=ffaff3&label=%F0%9F%93%A6 )] ( https://hex.pm/packages/glychee )
4
4
[ ![ Hex Docs] ( https://img.shields.io/badge/hex-docs-ffaff3?label=%F0%9F%93%9A )] ( https://hexdocs.pm/glychee/ )
5
5
[ ![ License] ( https://img.shields.io/hexpm/l/glychee?color=ffaff3&label=%F0%9F%93%83 )] ( https://github.com/inoas/glychee/blob/main/LICENSE )
6
6
7
7
A simple [ Gleam] ( https://gleam.run ) benchmark runner which wraps [ ** Benchee** ] ( https://github.com/bencheeorg/benchee ) for the heavy lifting.
8
8
9
- Named after * Gleam * , * Benchee * and their fruity [ * Lychee * ] ( https://en.wikipedia.org/wiki/Lychee ) offspring:
9
+ Named after _ Gleam _ , _ Benchee _ and their fruity [ _ Lychee _ ] ( https://en.wikipedia.org/wiki/Lychee ) offspring:
10
10
11
11
<figure >
12
12
<img src =" https://raw.githubusercontent.com/inoas/glychee/main/glychee-logo.jpg " alt =" Glychee Logo " style =" max-height : 33vh ; width : auto ; height : auto " width =" 480 " height =" 480 " />
@@ -18,13 +18,13 @@ Named after *Gleam*, *Benchee* and their fruity [*Lychee*](https://en.wikipedia.
18
18
- Requires ** Gleam 1.0** or later.
19
19
- For benchmarking on target JavaScript see < https://hex.pm/packages/gleamy_bench > ,
20
20
as Glychee only allows benchmarking on target Erlang.
21
- - Glychee is dependency free except for * Benchee * and * Elixir * .
21
+ - Glychee is dependency free except for _ Benchee _ and _ Elixir _ .
22
22
- A recent Elixir and Hex must be installed. You might be required to run
23
23
` mix local.hex ` after installing Elixir.
24
24
25
25
## Quick start
26
26
27
- 1 . Add *** Glychee * ** to your project: ` gleam add glychee --dev ` .
27
+ 1 . Add ** _ Glychee _ ** to your project: ` gleam add glychee --dev ` .
28
28
2 . Create a custom benchmarking module for example named ` my_benchmark ` that
29
29
contains a ` main ` -function. In that module you will define which ` Function ` s
30
30
to benchmark with one or many ` Data ` .
0 commit comments