Improve README formatting

This commit is contained in:
Samuel Sloniker 2022-04-08 21:53:22 -07:00
parent b31c714d9a
commit e41edb5e1b

View File

@ -12,29 +12,33 @@ particular, HTTP response codes are ignored (see #1).
git clone https://git.kj7rrv.com/kj7rrv/netrun git clone https://git.kj7rrv.com/kj7rrv/netrun
cd netrun cd netrun
python3 -m pip install requests # Or install requests with your distro's python3 -m pip install requests # See note
# package manager; just don't use pip as
# root or with sudo
python3 netrun.py https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/shell.sh python3 netrun.py https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/shell.sh
python3 netrun.py --interpreter=python3 https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/python.py python3 netrun.py --interpreter=python3 https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/python.py
python3 netrun.py --help python3 netrun.py --help
python3 -m pip install requests # Or
Note: You could also install requests with your distro's package manager; just
don't use pip as root or with sudo.
## Installation ## Installation
### Single user ### Single user
# requests must be installed either with pip (run as the same user that is `requests` must be installed either with `pip` (run as the same user that is
# installing and will use netrun), or with your distro's package manager; installing and will use `netrun`), or with your distro's package manager; do
# do not run pip as root or with sudo not run `pip` as root or with `sudo`
cp netrun.py ~/.local/bin/netrun cp netrun.py ~/.local/bin/netrun
chmod +x ~/.local/bin/netrun chmod +x ~/.local/bin/netrun
netrun https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/shell.sh netrun https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/shell.sh
### System-wide ### System-wide
# Install requests using your distro's package manager first; using pip as Install `requests` using your distro's package manager first; using `pip` as a
# a regular user only installs it for that user, and using it as root/with regular user only installs it for that user, and using it as root/with `sudo`
# sudo is not recommended is not recommended
sudo cp netrun.py /usr/bin/netrun sudo cp netrun.py /usr/bin/netrun
sudo chmod +x /usr/bin/netrun sudo chmod +x /usr/bin/netrun
sudo netrun https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/shell.sh sudo netrun https://git.kj7rrv.com/kj7rrv/netrun/raw/branch/master/demos/shell.sh