Skip to content
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.

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

Update README to Allow Install and Run Commands to Be Copied As Is #11722

Closed
wants to merge 2 commits into from

Conversation

pollyandhiscat
Copy link

The current version of the README contains extra text that make commands fail.

Example:

image

But if we use the command as is, we get an error:

image

image

My humble proposal is to align the README with other parts of the README, which adopts a similar format (without the dollar sign and output as part of the command text).

Here is an example currently in the README, at the bottom:

image

Additionally, this format is good as it aligns with other documentation formats, such as that used by GitHub. Here is an example from the GitHub docs on generating new SSH keys:

image

@tiangolo
Copy link
Owner

📝 Docs preview for commit ea2b0b1 at: https://5e1c09ff.fastapitiangolo.pages.dev

@alejsdev alejsdev added p5 docs Documentation about how to use FastAPI labels Jun 19, 2024
@tiangolo
Copy link
Owner

Thanks for the interest! This is because the README is more or less a copy of the markdown in the docs: https://fastapi.tiangolo.com/

Those commands are shown in a mini-animated terminal there. 🤓

So, I'll pass on this one, but thanks for the effort. ☕

@tiangolo tiangolo closed this Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation about how to use FastAPI p5
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants