From 5dda65235728084f42bed0f9b7fae687da4e11ba Mon Sep 17 00:00:00 2001 From: Ray Luo Date: Sat, 21 Oct 2023 12:10:48 -0700 Subject: [PATCH] Getting close --- README.md | 8 ++++---- setup.cfg | 1 + 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6b30527..b14f98b 100644 --- a/README.md +++ b/README.md @@ -95,16 +95,16 @@ Windows users please adjust the path separator in each sample. brip install -r brequirements.txt ``` - The file "**b**requirements.txt" has + The file `brequirements.txt` has [a format identical to `pip`'s "requirements.txt"](https://pip.pypa.io/en/stable/cli/pip_install/#requirements-file-format), and it can be named whatever name you want. We recommend using a name *different than* pip's conventional "requirements.txt", - though, such as "**b**requirements.txt", + though, such as `Brequirements.txt` (note the leading "B" or "b"), to remind you that its content are meant to be installed by `brip`, not by `pip`. * Uninstalling a package ... is not directly supported, but can be achieved by - organizing your full dependency list in a "**b**requirements.txt" file, + organizing your full dependency list in a `brequirements.txt` file, and then use this pattern: ``` @@ -128,7 +128,7 @@ But, due to some technical reason, `brip` always do overwrite installation. If you run `brip install foo` and then `brip install bar`, you would end up with only `bar` available in your Brython project. -Therefore, we recommend you always use a "**b**requirements.txt" +Therefore, we recommend you always use a `brequirements.txt` to organize your project's full dependency. That way, any adjustment to such a file would be flushed to your Brython project by next `brip install -r brequirements.txt`. diff --git a/setup.cfg b/setup.cfg index 3b4bc87..e4b2f1a 100644 --- a/setup.cfg +++ b/setup.cfg @@ -28,6 +28,7 @@ classifiers = # NOTE: Settings of this section below this line should not need to be changed long_description = file: README.md +long_description_content_type = "text/markdown" [options] python_requires = >=3.7