Skip to content

updated readme #92

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JinIgarashi merged 1 commit into from
Dec 13, 2024
Merged

updated readme #92

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,8 @@ Each `cbsurge`'s modules has its own test suite which can be ran independently
make test
```

before running the above command, please use `devcontainer` or `make shell` to enter to docker container first.

## Using docker

- build docker-image
Expand All @@ -47,15 +49,15 @@ make test
make build
```

- run CLI
- destroy docker container

```shell
./cbsurge.sh --help
make down
```

- enter to Docker container

```shell
make shell
./cbsurge.sh --help
./cbsurge.sh --help # run CLI in shell on docker container
```
Loading