Skip to content

Update README with installation instructions. #12

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

Open
jdidion wants to merge 3 commits into
base: master
Choose a base branch
from
+25 −0
Open

Update README with installation instructions. #12

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e19081e
Merge pull request #1 from sustrik/master
jdidion Jul 12, 2019
2fb090a
Update README with installation instructions
jdidion Jul 12, 2019
977d641
Update README with installation instructions
jdidion Jul 12, 2019
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
25 changes: 25 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,31 @@ Quasimodo 14:30
"Moby Dick" 14:22
</pre>

# INSTALLATION

Clone the repository:

```bash
$ git clone https://github.com/sustrik/uxy.git
```

You can now run `uxy` in one of several ways. Do one of these from within the `uxy` directory:

* Run `python -m uxy ...`
* Package the code into a zip file:
```bash
$ zip uxy.zip -r uxy
$ python uxy.zip ...
```
* Build and install a wheel using [poetry](https://github.com/sdispater/poetry/):
```bash
$ poetry build
$ pip3 install dist/uxy-0.1.0-py3-none-any.whl

# Now uxy should be in your $PATH, so from anywhere you can run:
$ uxy ...
```

# TOOLS

### UXY tools
Expand Down