Skip to content

Commit

Permalink
core: Fix image URLs in README.
Browse files Browse the repository at this point in the history
Also, update the install instructions to use Pipx or depend on venv.
  • Loading branch information
maxking committed Aug 2, 2023
1 parent a8ee6df commit f40bed6
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 14 deletions.
37 changes: 24 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,38 @@ A terminal based archive reader for Hyperkitty, GNU Mailman's official archiver.
Screenshots
-----------

![Page Add Mailinglist](screenshots/page_subscribe_mailinglist.svg)
![Page Add Mailinglist](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_subscribe_mailinglist.svg)

![Page View threads](screenshots/page_threads_list.svg)
![Page View threads](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_threads_list.svg)

![Page Read Thread](screenshots/page_read_thread.svg)
![Page Read Thread](https://raw.githubusercontent.com/maxking/archive_reader/main/screenshots/page_read_thread.svg)

Using
-----

Hyperkitty Configuration
------------------------

In order to use this app, the Pagination on the Hyperkitty's API needs to be set correctly.
To run the app, you can install it using [Pipx](https://pypa.github.io/pipx/):

```bash
# Install using pipx.
$ pipx install areader

# Run the app:
$ areader
```

Running
-------
To run the app, first you need to create a virtualenv and then finally install dependencies.
If you don't have Pipx, you can install directly in a venv to run:

```bash
# Setup a virtualenv to install the package.
$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install -e .
$ pdm run start
```
$ pip install areader

# Run the app:
$ areader
```

Hyperkitty Configuration
------------------------

In order to use this app, the Pagination on the Hyperkitty's API needs to be set correctly.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "areader"
version = "0.1.0"
version = "0.1.1"
description = "Terminal based archives reader for Hyperkitty, GNU Mailman's archiver"
authors = [
{name = "Abhilash Raj", email = "[email protected]"},
Expand Down

0 comments on commit f40bed6

Please sign in to comment.