Skip to content

Commit 228a87e

Browse files
committed
Update README.md
1 parent 449a505 commit 228a87e

File tree

1 file changed

+33
-3
lines changed

1 file changed

+33
-3
lines changed

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
1-
# samtools-mruby
1+
# bcftools-mruby
22

33
[![build](https://github.com/kojix2/bcftools-tanuki/actions/workflows/build.yml/badge.svg)](https://github.com/kojix2/bcftools-tanuki/actions/workflows/build.yml)
44

5+
Use [mruby](https://github.com/mruby/mruby) to evaluate expressions.
6+
7+
## Installation
8+
9+
```
10+
git clone --recurse-submodules https://github.com/kojix2/bcftools-mruby
11+
./build.sh
12+
bcftools/bcftools tanuki # check if it works
13+
```
14+
515
```
616
    __,-─-、__
717
   (〆-─-ヽ)
@@ -13,6 +23,26 @@
1323
tanuki in bcftools
1424
```
1525

26+
[Rake](https://github.com/ruby/rake) is required to build mruby.
27+
If you are using [conda to install Ruby](https://dev.to/kojix2/using-ruby-with-conda-1hn), setting the `LD` environment may work.
28+
29+
```sh
30+
rake LD=/usr/bin/gcc MRUBY_CONFIG=$(pwd)/mruby_build_config.rb -f $(pwd)/mruby/Rakefile
1631
```
17-
./build.sh
18-
```
32+
33+
## Usage
34+
35+
## Development
36+
37+
## Contributing
38+
39+
- Fork it
40+
- Pull Request welcome
41+
42+
## License
43+
44+
MIT
45+
46+
## Related Projects
47+
48+
- [samtools-mruby](https://github.com/kojix2/samtools-mruby)

0 commit comments

Comments
 (0)