Skip to content

Commit

Permalink
Merge pull request #26 from alps-asd/brew-install
Browse files Browse the repository at this point in the history
Update quick-start guide with Homebrew installation
  • Loading branch information
koriym committed Jun 15, 2024
2 parents 86314c5 + da4022e commit f02b801
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 11 deletions.
29 changes: 22 additions & 7 deletions manuals/1.0/en/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,36 @@ permalink: /manuals/1.0/en/quick-start.html

## Requirement

ASD requires [Docker](https://www.docker.com/products/docker-desktop).
You need [Homebrew](https://brew.sh/ja/) or [Docker](https://www.docker.com/products/docker-desktop) to run ASD.

## Install
## Homebrew

Install the asd command.
Recommended. Do the following

```shell
brew install alps-asd/asd/asd
````

To uninstall, do the following:

```shell
brew uninstall asd
brew untap alps-asd/asd
````

## Docker

Install the asd command with the following command.

```
curl -L https://alps-asd.github.io/app-state-diagram/asd.sh > ./asd && chmod +x ./asd && sudo mv ./asd /usr/local/bin
curl -L https://alps-asd.github.io/app-state-diagram/asd.sh > . /asd && chmod +x . /asd && sudo mv . /asd /usr/local/bin
```

## Run the demo
## Demo

The following will start the development server.
After installing either Homebrew or Docker, let's run the demo.

```
```shell
mkdir work
curl -L curl https://alps-asd.github.io/app-state-diagram/blog/profile.json > work/profile.json
asd --watch ./work/profile.json
Expand Down
23 changes: 19 additions & 4 deletions manuals/1.0/ja/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,34 @@ permalink: /manuals/1.0/ja/quick-start.html

## 環境

ASDの実行には[Docker](https://www.docker.com/products/docker-desktop)が必要です。
ASDの実行には[Homebrew](https://brew.sh/ja/)または[Docker](https://www.docker.com/products/docker-desktop)が必要です。

## インストール
## Homebrew

お勧めの方法です。以下のようにします。

```shell
brew install alps-asd/asd/asd
```

アンインストールするには以下のようにします。

```shell
brew uninstall asd
brew untap alps-asd/asd
```

## Docker

次のコマンドでasdコマンドをインストールします。

```
curl -L https://alps-asd.github.io/app-state-diagram/asd.sh > ./asd && chmod +x ./asd && sudo mv ./asd /usr/local/bin
```

## デモの実行
## デモ

以下の操作でASDサーバーが起動します
HomebrewまたはDockerいずれかの方法でインストールを行った後は早速デモを実行してみましょう

```
mkdir work
Expand Down

0 comments on commit f02b801

Please sign in to comment.