Skip to content

Commit

Permalink
Getting close
Browse files Browse the repository at this point in the history
  • Loading branch information
rayluo committed Oct 21, 2023
1 parent e6b73b5 commit 5dda652
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

```
Expand All @@ -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`.
Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5dda652

Please sign in to comment.