Update readme

This commit is contained in:
grym 2022-12-01 12:31:44 -05:00
parent 5f24476957
commit 7f09776064
1 changed files with 24 additions and 19 deletions

View File

@ -1,26 +1,7 @@
* 0x0 uploader
This is a very lightweight front-end to the [[http://0x0.st][0x0 pastebin service]] for slightly easier
command line use.
** Installation
*** pipx
#+begin_src bash
pipx install git+https://tildegit.org/grym/oxo@master # or @tag-of-your-choice
#+end_src
*** pip
#+begin_src bash
python3 -m venv oxovenv
oxovenv/bin/pip install git+https://tildegit.org/grym/oxo@master # or @tag-of-your-choice
ln -s oxovenv/bin/oxo ${HOME}/.local/bin # optional.
#+end_src
*** development
#+begin_src bash
git clone https://tildegit.org/grym/oxo
cd oxo
make install
#+end_src
** Use
Each of the three endpoints supported by 0x0 has an associated subcommand.
#+begin_src bash :results output replace :tangle no
oxo --help
#+end_src
@ -48,3 +29,27 @@ oxo --help
╰──────────────────────────────────────────────────────────────────────────────╯
#+end_example
** Installation
*** pipx
[[https://pypa.github.io/pipx/][pipx]] automates the creation of isolated runtimes for python CLI utilities like
=oxo=. Once =pipx= is installed, install =oxo= like so, and it'll be on your
=$PATH=
#+begin_src bash
pipx install git+https://tildegit.org/grym/oxo@master # or @tag-of-your-choice
#+end_src
*** pip + venv
If you'd prefer to create or manage your own isolated runtime for =oxo=, create
a venv and install =oxo= into it:
#+begin_src bash
python3 -m venv oxovenv #or wherever you want the venv to go
oxovenv/bin/pip install git+https://tildegit.org/grym/oxo@master # or @tag-of-your-choice
ln -s oxovenv/bin/oxo ${HOME}/.local/bin # optionally add to here, or anywhere else on your $PATH
#+end_src
*** development
If you'd like to set up a development install to edit oxo on your own (to
prepare a PR, for example):
#+begin_src bash
git clone https://tildegit.org/grym/oxo
cd oxo
make install
#+end_src