pynex/README.md

28 lines
626 B
Markdown
Raw Permalink Normal View History

2023-07-02 22:31:48 +00:00
# PyNex
A terminal browser for the [Nex](https://nex.nightfall.city) protocol written in Python
Very early version, probably lots of bugs.
2023-07-03 08:58:28 +00:00
## Installation
PyNex's only dependency is [PyTermGUI](https://github.com/bczsalba/pytermgui), a library for creating terminal applications. It can be installed with the following command, preferably in a virtual environment.
```
pip install -r requirements.txt
```
2023-07-02 22:31:48 +00:00
## Usage
```
python nex.py <locator>
```
For example
```
python nex.py nex.nightfall.city
```
2023-07-03 18:35:25 +00:00
Use the arrow keys or k and j to scroll up and down. Number keys 0-9 will follow the corresponding link on the page.