search

tiangolo / fastapi

FastAPI framework, high performance, easy to learn, fast to code, ready for production
https://fastapi.tiangolo.com/
MIT License
73.13k stars 6.16k forks source link

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

Open pollyandhiscat opened 2 weeks ago

pollyandhiscat commented 2 weeks ago

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 commented 2 weeks ago

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