aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0ee79698934024ac09e511ae8d6b9e6d7a7814c9 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
# Jake's Gemini Client

This program is written with the latest version of Perl5.
It has several dependencies which can be easily installed via cpan or cpanm.

## To use
* Make sure you have the latest Perl installed
* get the dependencies:

sudo cpanm IO::Socket::SSL URL::XS IO::Pager Text::Wraper Term::ReadKey Path::Naive  Text::ParseWords Term::ReadLine Smart::Comments URI::Encode IO::Socket::SSL::Utils File::Slurper File::BaseDir TOML

* Clone the repo, in an approprate directory

$ git clone http://git.jakesthoughts.xyz/dev/gemini-client

You should check the script to make sure that the dependencies list is up to date.

The author (me) recommends that you also install Term::ReadLine::Gnu so that tab will auto-complete commands.

## Usage
If you have Term::ReadLine::Gnu then you can use press the tab key twice to get a list of commands. Otherwise, use the command: 'commands' or the alias 'cmds' to get a list of commands and a brief description of what each command does.

Use help in front of the command to get a description of what it does.

To get started:
Use 'url', or it's alias, 'u' and type out a destination.

Here are some cool ones for you:
* gemini://astrobotany.mozz.us/
* gemini://gemini.circumlunar.space/docs/specification.gmi
* gemini://geminispace.info/

## GUI
You can get an experimental GUI version of this program by:

$ git clone -b tk-gui http://git.jakesthoughts.xyz/dev/gemini-client

Do note that it is still in progress and no where near completed. Bugs and missing features are guaranteed.

## Windows
I do not know if this software will work on Windows. I believe one of the dependencies is not Windows friendly but I forget which.