annotate README.md @ 2:e86dfb640e86

update
author akahori
date Tue, 26 Mar 2019 12:49:43 +0900
parents 95eafbd91f41
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
1 title: README.md
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
2 author: kiichi aka
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
3 profile: Ryukyu Concurrency Reliance Lablatory
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
4 lang: Japanese
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
5 code-engine: coderay
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
6
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
7 # What This
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
8 これは, markdownから並列信頼研のロゴが入ったスライドを生成するdockerです.
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
9
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
10 This is a docker that generates a slide with the Concurrency Reliance Lab logo from markdown.
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
11
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
12 # How Use
2
akahori
parents: 0
diff changeset
13
akahori
parents: 0
diff changeset
14 ## Use Makefile
akahori
parents: 0
diff changeset
15
akahori
parents: 0
diff changeset
16 makeファイルでのdockerはmake buildで行えます.
akahori
parents: 0
diff changeset
17
akahori
parents: 0
diff changeset
18 ```
akahori
parents: 0
diff changeset
19 make build
akahori
parents: 0
diff changeset
20 ```
akahori
parents: 0
diff changeset
21
akahori
parents: 0
diff changeset
22 buildが成功したら次のコマンドを使うことで, カレントディレクトリにREADME.mdのhtml, pdf.htmlが生成されます.
akahori
parents: 0
diff changeset
23
akahori
parents: 0
diff changeset
24 If build is successful, using following command will generate html and pdf.html from README.md in the current directory.
akahori
parents: 0
diff changeset
25
akahori
parents: 0
diff changeset
26 ```
akahori
parents: 0
diff changeset
27 make run
akahori
parents: 0
diff changeset
28 ```
akahori
parents: 0
diff changeset
29
akahori
parents: 0
diff changeset
30 他のファイルを指定したいときはMDオプションにファイル名を与えます.
akahori
parents: 0
diff changeset
31
akahori
parents: 0
diff changeset
32 ```
akahori
parents: 0
diff changeset
33 make run MD=sample.md
akahori
parents: 0
diff changeset
34 ```
akahori
parents: 0
diff changeset
35
akahori
parents: 0
diff changeset
36 make cleanで, build済のdocker, contener, 生成されたファイルを削除します
akahori
parents: 0
diff changeset
37
akahori
parents: 0
diff changeset
38 ```
akahori
parents: 0
diff changeset
39 make clean
akahori
parents: 0
diff changeset
40 ```
akahori
parents: 0
diff changeset
41
akahori
parents: 0
diff changeset
42 make cleanfで, 生成されたファイルのみ削除できます.
akahori
parents: 0
diff changeset
43
akahori
parents: 0
diff changeset
44 ```
akahori
parents: 0
diff changeset
45 make cleanf
akahori
parents: 0
diff changeset
46 ```
akahori
parents: 0
diff changeset
47
akahori
parents: 0
diff changeset
48 ## Use Command
0
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
49 dockerをbuildします.
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
50
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
51 Build docker.
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
52 ```
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
53 docker build -t slide_docker .
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
54 ```
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
55
2
akahori
parents: 0
diff changeset
56 buildが成功したら次のコマンドを使うことで, カレントディレクトリにREADME.mdのhtml, pdf.htmlが生成されます.
0
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
57
2
akahori
parents: 0
diff changeset
58 If build is successful, using following command will generate html and pdf.html from README.md in the current directory.
0
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
59
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
60 ```
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
61 docker run --rm -v $PWD:/slideshow slide_docker:latest
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
62 ```
95eafbd91f41 add dockerfile
akahori
parents:
diff changeset
63
2
akahori
parents: 0
diff changeset
64 他のファイルを指定したいときは後ろにファイル名の引数を与えます.
akahori
parents: 0
diff changeset
65
akahori
parents: 0
diff changeset
66 ```
akahori
parents: 0
diff changeset
67 docker run --rm -v $PWD:/slideshow slide_docker:latest sample.md
akahori
parents: 0
diff changeset
68 ```
akahori
parents: 0
diff changeset
69