Skip to content

Commit b03fdd6

Browse files
authored
Merge pull request #367 from unique-EJ/master
Update README.rst - needs a code escape 😯
2 parents 9784c0e + e88c03e commit b03fdd6

2 files changed

Lines changed: 24 additions & 20 deletions

File tree

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ jobs:
1515
- name: Set up Python
1616
uses: actions/setup-python@v1
1717
with:
18-
python-version: 3.8
18+
python-version: 3.9
1919
- name: Test
2020
run: |
21-
python setup.py bdist_wheel
21+
python setup.py bdist_wheel

README.rst

Lines changed: 22 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -65,28 +65,32 @@ OS Requirements
6565

6666
* OSX with docker for desktop: Limited support
6767

68-
* `inherit-timezone` is ignored
69-
* xpra (graphical apps) doesnt work
70-
* Probaly other issues
68+
* ``inherit-timezone`` is ignored
69+
* xpra (graphical apps) doesn't work
70+
* Probably other issues
7171

7272
Install with pip3: Stable version
7373
--------------------------------
7474

75-
1. Add yourself to the sudo group (or the docker group).
75+
1. Add yourself to the ``sudo`` group (or the ``docker`` group).
7676

77-
::
77+
::
7878

79-
$ sudo nano /etc/group
79+
$ sudo nano /etc/group
8080

81-
Find ``sudo`` and add your username to the end of the line.
81+
Find ``sudo`` and add your username to the end of the line.
8282

8383
2. Install subuser from pip3. In a virtual environment if Python 3 is managed by Debian/Ubuntu distribution packaging.
8484

85-
$ sudo pip3 install subuser
85+
::
86+
87+
$ sudo pip3 install subuser
8688

8789
3. Add ``~/.subuser/bin`` to your path by adding the line ``PATH=$HOME/.subuser/bin:$PATH`` to the end of your ``.bashrc`` file.
8890

89-
$ echo -n -e '\nPATH=$HOME/.subuser/bin:$PATH' >> ~/.bashrc
91+
::
92+
93+
$ echo -n -e '\nPATH=$HOME/.subuser/bin:$PATH' >> ~/.bashrc
9094

9195
4. Log out and then back in again.
9296

@@ -95,23 +99,23 @@ Find ``sudo`` and add your username to the end of the line.
9599
Install from git: Development version
96100
-------------------------------------
97101

98-
1. Add yourself to the `sudo` group (this is not necesary if you are already a member of the docker group).
102+
1. Add yourself to the ``sudo`` group (this is not necessary if you are already a member of the ``docker`` group).
99103

100-
2. Download the subuser repository
104+
2. Download the subuser repository::
101105

102-
::
103-
104-
$ cd
105-
$ git clone https://github.com/subuser-security/subuser
106+
$ cd
107+
$ git clone https://github.com/subuser-security/subuser
106108

107109
3. Add ``subuser/logic`` and ``~/.subuser/bin`` to your path by adding the line ``PATH=$HOME/subuser/logic:$HOME/.subuser/bin:$PATH`` to the end of your ``.bashrc`` file.
108110

109-
$ echo -n -e '\nPATH=$HOME/subuser/logic:$HOME/.subuser/bin:$PATH' >> ~/.bashrc
111+
::
112+
113+
$ echo -n -e '\nPATH=$HOME/subuser/logic:$HOME/.subuser/bin:$PATH' >> ~/.bashrc
110114

111-
.. note:: You will need to change the path to ``subuser/logic`` to refer to the location to which you downloaded subuser.
115+
.. note:: You will need to change the path to ``subuser/logic`` to refer to the location to which you downloaded subuser.
112116

113117
4. Log out and then back in again.
114118

115119
5. Done!
116120

117-
To learn more and read the full manual please visit `subuser.org <https://subuser.org>`_
121+
To learn more and read the full manual please visit `subuser.org <https://subuser.org>`_.

0 commit comments

Comments
 (0)