Skip to content

slight clarification in README.md #93

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

Open
bencium wants to merge 1 commit into
base: main
Choose a base branch
from
Open

slight clarification in README.md #93

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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,8 @@ graph LR
cp .env.example .env

# Start the application using Docker/Podman Compose
docker/podman compose --env-file .env up
Docker: docker compose --env-file .env up
Podman: podman compose --env-file .env up
Comment on lines +137 to +138

@gemini-code-assist gemini-code-assist Bot Jun 7, 2025

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The current formatting with Docker: and Podman: prefixes on the command lines themselves will cause an error if a user tries to copy and paste the entire line into their terminal. To improve usability and truly make the commands 'super clear' and easy to run, it would be better to have the descriptive labels as comments and the commands themselves as directly executable lines.

Could we reformat this to ensure the commands are directly copy-pasteable?

Suggested change
Docker: docker compose --env-file .env up
Podman: podman compose --env-file .env up
# Using Docker:
docker compose --env-file .env up
# Using Podman:
podman compose --env-file .env up

```

For existing users, use:
Expand Down