Skip to content

Update README.rst - needs a code escape 😯 #367

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timthelion merged 4 commits into from
Feb 23, 2025
Merged

Update README.rst - needs a code escape 😯 #367

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c8a5c1e
Update README.rst - needs a backslash code escape 😯
unique-EJ Feb 23, 2025
379b451
Update README.rst - literal code blocks and reStructuredText indentat…
unique-EJ Feb 23, 2025
52e9fa6
Update ci.yml
unique-EJ Feb 23, 2025
e88c03e
Merge pull request #2 from unique-EJ/patch-2
unique-EJ Feb 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
- name: Set up Python
uses: actions/setup-python@v1
with:
python-version: 3.8
python-version: 3.9
- name: Test
run: |
python setup.py bdist_wheel
python setup.py bdist_wheel
40 changes: 22 additions & 18 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,28 +65,32 @@ OS Requirements

* OSX with docker for desktop: Limited support

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

Install with pip3: Stable version
--------------------------------

1. Add yourself to the sudo group (or the docker group).
1. Add yourself to the ``sudo`` group (or the ``docker`` group).

::
::

$ sudo nano /etc/group
$ sudo nano /etc/group

Find ``sudo`` and add your username to the end of the line.
Find ``sudo`` and add your username to the end of the line.

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

$ sudo pip3 install subuser
::

$ sudo pip3 install subuser

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

$ echo -n -e '\nPATH=$HOME/.subuser/bin:$PATH' >> ~/.bashrc
::

$ echo -n -e '\nPATH=$HOME/.subuser/bin:$PATH' >> ~/.bashrc

4. Log out and then back in again.

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

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

2. Download the subuser repository
2. Download the subuser repository::

::

$ cd
$ git clone https://github.com/subuser-security/subuser
$ cd
$ git clone https://github.com/subuser-security/subuser

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.

$ echo -n -e '\nPATH=$HOME/subuser/logic:$HOME/.subuser/bin:$PATH' >> ~/.bashrc
::

$ echo -n -e '\nPATH=$HOME/subuser/logic:$HOME/.subuser/bin:$PATH' >> ~/.bashrc

.. note:: You will need to change the path to ``subuser/logic`` to refer to the location to which you downloaded subuser.
.. note:: You will need to change the path to ``subuser/logic`` to refer to the location to which you downloaded subuser.

4. Log out and then back in again.

5. Done!

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