From fc8d83a881371e803f5c99cae065d572f79ab673 Mon Sep 17 00:00:00 2001 From: jake Date: Mon, 7 Feb 2022 02:17:39 -0500 Subject: rename README to README.md --- README | 25 ------------------------- README.md | 25 +++++++++++++++++++++++++ 2 files changed, 25 insertions(+), 25 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 19dd55d..0000000 --- a/README +++ /dev/null @@ -1,25 +0,0 @@ -# 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 - -You should check the script to make sure that the decency list is up to date. - -## Usage -Press twice to see the list of available commands. Use help in front of the command to get a description of what it does. - -Use 'url', or it's alias, 'u' and type out a destination. - -## GUI -You can get an experimental GUI version of this program by: -$ git clone -b tk-gui - -Please note that the GUI version of this software is EXPERIMENTAL and should not be considered a final product. It IS subject to change. - -## 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..19dd55d --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# 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 + +You should check the script to make sure that the decency list is up to date. + +## Usage +Press twice to see the list of available commands. Use help in front of the command to get a description of what it does. + +Use 'url', or it's alias, 'u' and type out a destination. + +## GUI +You can get an experimental GUI version of this program by: +$ git clone -b tk-gui + +Please note that the GUI version of this software is EXPERIMENTAL and should not be considered a final product. It IS subject to change. + +## 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. -- cgit v1.2.3