Skip to content

Commit

Permalink
README and man page
Browse files Browse the repository at this point in the history
  • Loading branch information
ckardaris committed Feb 10, 2019
1 parent 9a48b5e commit 2238b47
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# tormix
<a href="https://imgur.com/gallery/zrP4rGm" target="_blank"><img src="https://i.imgur.com/3jCzXVt.png" alt="img" height="200px"/></a>

Based on the <a href="https://github.com/dylanaraps/torque">original project</a> from <a href="https://github.com/dylanaraps">dylanaraps</a>
I decided to add many more features
Based on the <a href="https://github.com/dylanaraps/torque">original project</a> from <a href="https://github.com/dylanaraps">dylanaraps</a><br>
I decided to change the name (to not conflict with other existing programs) and add many more features

A simple TUI client for `transmission-daemon`.
A simple TUI client for the `transmission-cli`.

- Written in `bash`.


## Dependencies

- `bash`
Expand All @@ -19,3 +19,9 @@ A simple TUI client for `transmission-daemon`.
2. Run `tormix`.

## Features
- Autocomplete of torrent ids to start, pause or remove them
- Autocomplete of local paths to add new torrent
- Customizable color themes
- Smoother interface (as few screen redraws as possible

... More to come
4 changes: 4 additions & 0 deletions tormix.1
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@ is a TUI (terminal user interface) written in pure bash, created to provide supp
program.
It makes easy the actions of adding, removing, starting and pausing torrents,
while providing a clean interface with customizable colors.
.SH USAGE
1. start 'transmission-daemon'

2. run 'tormix'
.SH COLORS
After the installation, all available color themes are placed in the directory
.I $HOME/.config/tormix/themes/
Expand Down

0 comments on commit 2238b47

Please sign in to comment.