view README.md @ 3:c23adc60a4f5 default tip

add makefile
author akahori
date Tue, 26 Mar 2019 12:50:24 +0900
parents e86dfb640e86
children
line wrap: on
line source

title: README.md
author: kiichi aka
profile: Ryukyu Concurrency Reliance Lablatory
lang: Japanese
code-engine: coderay

# What This
これは, markdownから並列信頼研のロゴが入ったスライドを生成するdockerです. 

This is a docker that generates a slide with the Concurrency Reliance Lab logo from markdown.

# How Use

## Use Makefile 

makeファイルでのdockerはmake buildで行えます.

```
make build
```

buildが成功したら次のコマンドを使うことで, カレントディレクトリにREADME.mdのhtml, pdf.htmlが生成されます.

If build is successful, using following command will generate html and pdf.html from README.md in the current directory.

```
make run
```

他のファイルを指定したいときはMDオプションにファイル名を与えます.

```
make run MD=sample.md
```

make cleanで, build済のdocker, contener, 生成されたファイルを削除します

```
make clean
```

make cleanfで, 生成されたファイルのみ削除できます.

```
make cleanf
```

## Use Command
dockerをbuildします.

Build docker.
```
docker build -t slide_docker . 
```

buildが成功したら次のコマンドを使うことで, カレントディレクトリにREADME.mdのhtml, pdf.htmlが生成されます.

If build is successful, using following command will generate html and pdf.html from README.md in the current directory.

```
docker run --rm -v $PWD:/slideshow slide_docker:latest 
```

他のファイルを指定したいときは後ろにファイル名の引数を与えます.

```
docker run --rm -v $PWD:/slideshow slide_docker:latest sample.md
```