summaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorKonstantin Ryabitsev <konstantin@linuxfoundation.org>2020-12-03 15:12:51 -0500
committerKonstantin Ryabitsev <konstantin@linuxfoundation.org>2020-12-03 15:12:51 -0500
commit3e231ea74ade46fbc5ebdee9d21bf25b8dd014d4 (patch)
treea866f94932f8f071b81aca1a6b0ec730cc5a6d61 /README.rst
parent62c8d5fc878bd9a6fd2f5d0f9b92d413c32d658f (diff)
downloadb4-3e231ea74ade46fbc5ebdee9d21bf25b8dd014d4.tar.gz
Fix ReST in README.rst
Looks like it's not properly rendering on git.kernel.org. Signed-off-by: Konstantin Ryabitsev <konstantin@linuxfoundation.org>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst18
1 files changed, 10 insertions, 8 deletions
diff --git a/README.rst b/README.rst
index 266c62a..166eb9a 100644
--- a/README.rst
+++ b/README.rst
@@ -1,3 +1,5 @@
+B4 tools
+========
This is a helper utility to work with patches made available via a
public-inbox archive like lore.kernel.org. It is written to make it
easier to participate in a patch-based workflows, like those used in
@@ -10,21 +12,21 @@ See man/b4.5.rst for more information.
Installing
----------
-```
-python3 -m pip install --user b4
-```
+To install from pypi::
+
+ python3 -m pip install --user b4
Upgrading
---------
-```
-python3 -m pip install --user --upgrade b4
-```
+If you previously installed from pypi::
+
+ python3 -m pip install --user --upgrade b4
Running from the checkout dir
-----------------------------
If you want to run from the checkout dir without installing the python
-package, you can use the included b4.sh wrapper. You can set it as an
-alias in your .bash_profile::
+package, you can use the included ``b4.sh`` wrapper. You can set it as
+an alias in your .bash_profile::
alias b4="$HOME/path/to/b4/b4.sh"