Skip to content

Commit

Permalink
Updated dockerfile to make it easier to run as a cli tool
Browse files Browse the repository at this point in the history
  • Loading branch information
beveradb committed Mar 6, 2024
1 parent be44a7b commit de600eb
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
7 changes: 5 additions & 2 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,8 @@ WORKDIR /app
# Install the logo-diagram-generator package
RUN pip install logo-diagram-generator

# Set the default command to run the logo-diagram-generator
CMD ["logo-diagram-generator"]
# Configure docker to run the logo-diagram-generator
ENTRYPOINT ["logo-diagram-generator"]

# Set the default args to pass if none are specified
CMD [ "--help" ]
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,8 @@ This package, `logo-diagram-generator`, allows you to generate SVG diagrams that

Here's an example of a diagram generated using `logo-diagram-generator`, based on an example configuration:

```
pip install logo-diagram-generator
logo-diagram-generator -c examples/full.example.yml -o examples -n full.example
```bash
docker run -it -v `pwd`:/app beveradb/logo-diagram-generator -c examples/full.example.yml
```

![Example Diagram](examples/full.example_logos.svg)
Expand All @@ -26,6 +25,12 @@ logo-diagram-generator -c examples/full.example.yml -o examples -n full.example
pip install logo-diagram-generator
```

**🐳 Alternately, use Docker and skip to step 3! 🎉**
```bash
docker run -it -v `pwd`:/app beveradb/logo-diagram-generator
```
If you use Docker, you don't need to install anything on your system as the tool runs in a container.
2. **Install Graphviz**
This tool uses [Graphviz](https://graphviz.org/) to render the graph, so you need the graphviz binaries installed on your system for this to work.
Expand Down

0 comments on commit de600eb

Please sign in to comment.