Skip to content

Commit

Permalink
Unstable init
Browse files Browse the repository at this point in the history
  • Loading branch information
xezo360hye committed Apr 3, 2022
1 parent 5ff1b20 commit ec8d2e6
Show file tree
Hide file tree
Showing 2 changed files with 249 additions and 106 deletions.
43 changes: 25 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,23 +5,26 @@ Conics `(CONsole comICS)` is a program that helps you watch comics from `xkcd.co

# Installation

## Step 1 - dependencies
## Dependencies

Conics uses FBI (**F**rame**B**uffer **I**mageviewer) and cURL so install them
Conics requires FBI or FIM to display images using framebuffer, so you need one or both installed

Arch (FBI is in AUR):
Arch (FIM is in AUR):

`yay -S curl fbida`
```
sudo pacman -S fbida
yay -S fim
```

Debian, Ubuntu, Mint:
Debian, Ubuntu and derivatives:

`sudo apt-get install fbi`
`sudo apt-get install fbi fim`

Other:

Idk, please tell me if you know

## Step 2 - main
## Project

Run the following commands to install this program:

Expand All @@ -39,34 +42,38 @@ sudo mv Conics/conics /usr/local/bin/
rm -rf Conics
```

And you are done!
This will do all the job needed

# Usage
*If you don't have root access, instead of 3rd command run `mv Conics/conics ~/.bin/conics` or move that file to wherever you have acces in $PATH*

## General
# Usage

To get help message use `conics -h` or `conics --help` - there's all you need to know about arguments

To navigate through downloaded images, use `J` and `K` keys, or `space` to move forward UNTIL THE LAST ONE REACHED. Press `H` in FBI to get more info

## Options
# Options

### Dir (-d)
## Dir (-d)

Use to specify the directory where downloaded images will be stored - for example, `~/Pictures` or `.hidden_memes`. Default folder is *.* (current working directory)

### Format (-f)
## Format (-f)

Format is used in `mktemp` command, so check it for more information. It needs to end with 3 or more X's that will be replaced with random ~letters and numbers~ alnums. By default format is *img-XXXXX*

### Count (-c)
## Count (-c)

Count of comics you want to see. If not used, only one will be shown *(have you done your homework yet?)*

### Time (-t)
## Time (-t)

Great feature of FBI: if you don't press any key in ARG seconds, it automatically goes to the next one

## Remove (-r)

To remove files after closing FBI / FIM. By default it's false, use this flag to change to true

Great feature of FBI: if you don't press any key in <> seconds, it automatically goes to the next one. Closes when reached to the end
## Viewer (-w)

### Remove (-r)

Use it with or without argument. If next arg after -r is `true` or `false`, conics uses it, but if not it'll set it to *true*. However, the default value is *false*
Loading

0 comments on commit ec8d2e6

Please sign in to comment.