Skip to content

Commit 5f1e184

Browse files
authored
📝 Add Install and Usage headers
1 parent 1fcf950 commit 5f1e184

1 file changed

Lines changed: 17 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,30 @@ https://github.com/jankatins/knitpy
1414
https://github.com/pystitch/stitch
1515

1616

17+
## Install
1718

18-
## Quick Start
19+
```
20+
gem install specific_install
21+
gem specific_install https://github.com/sciruby-jp/rubydown
22+
```
23+
24+
## Usage
25+
26+
```
27+
git clone git://github.com/sciruby-jp/rubydown
28+
cd rubydown/examples
29+
/usr/local/bundle/bin/rubydown -i rumale.md -e /usr/local/bundle/gems/rubydown-0.1.0/templates/template.html.erb -o rumale-test.html
30+
```
31+
32+
33+
## Quick Start (with Docker)
1934

2035
```
2136
docker run -it -v c:/Users:/data ruby bash
2237
gem install specific_install
2338
gem specific_install https://github.com/sciruby-jp/rubydown.git
2439
apt update
2540
apt install gnuplot
26-
rubydown -i /usr/local/bundle/gems/rubydown-0.1.0/examples/data_science.md -e /usr/local/bundle/gems/rubydown-0.1.0/templates/template.html.erb -o /data/YOURNAME/data_science.html
41+
/usr/local/bundle/bin/rubydown -i /usr/local/bundle/gems/rubydown-0.1.0/examples/data_science.md -e /usr/local/bundle/gems/rubydown-0.1.0/templates/template.html.erb -o /data/YOURNAME/data_science.html
2742
cp data_science.md /data/YOURNAME/data_science.md
2843
```

0 commit comments

Comments
 (0)