From 3e981fd8bede0bd07714e5a774ad4da822cc1fcf Mon Sep 17 00:00:00 2001 From: Dianne Skoll Date: Thu, 19 Dec 2024 10:20:25 -0500 Subject: [PATCH] Convert README file to Markdown. That is what all the cool kids use. --- README | 78 ------------------------------------------------------- README.md | 63 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 63 insertions(+), 78 deletions(-) delete mode 100644 README create mode 100644 README.md diff --git a/README b/README deleted file mode 100644 index 48c09964..00000000 --- a/README +++ /dev/null @@ -1,78 +0,0 @@ - REMIND - -Remind is a full-featured calendar/alarm program. Copying policy is -in the file "COPYRIGHT" in this directory. - -Installation notes for various operating systems are in "docs". See -the appropriate README file for installation on your system. - -Manual pages are in "man". - ------------------------------------------------------------------------------ - -Quick UNIX installation instructions for the very impatient: - -If you have Tcl/Tk (wish 4.1 or higher) installed and are running X Windows: --------------------------------------------------------------- - -1) Type: wish ./build.tk from this directory. Fill in the various - options and hit "Build Remind" - -2) Type: "make install" -- you may need to be root to do this. - -If you do NOT have Tcl/Tk or are NOT running X Windows: -------------------------------------------------------- - -1) Edit the file "src/custom.h" according to your preferences. - -2) Edit the file "src/lang.h" to choose a language. - -3) Type: "./configure" (You can supply options; type "./configure --help" - for details.) - -4) Type: "make" - -5) Type: "make install" -- you may need to be root to do this. - -PREREQUISITES: --------------- - -Remind and rem2ps have no prerequisites beyond the standard C library and -the standard math library. - -Rem2HTML requires the JSON::MaybeXS Perl module. -Rem2PDF requires the JSON::MaybeXS, Pango and Cairo Perl modules. - -- On Debian-like systems, these prerequisites may be installed with: - - apt install libjson-maybexs-perl libpango-perl libcairo-perl - -- On RPM-based systems, you need perl-Pango, perl-Cairo and perl-JSON-MaybeXS - -- On Gentoo, you need dev-perl/Pango, dev-perl/Cairo and dev-perl/JSON-MaybeXS. - -- On Arch linux, you need pango-perl, cairo-perl and perl-json-maybexs - -TkRemind requires Tcl/Tk and the tcllib library. - -- On Debian-like systems, install with: - - apt install tcl tk tcllib - -- On RPM-based systems, you need tcl, tk and tcllib - -- On Arch Linux, you need tk and tcllib. The latter is available at - https://aur.archlinux.org/packages/tcllib - -If the little arrows for "Previous Month" and "Next Month" do not display -correctly in TkRemind, you may need to install the Noto Fonts. Install -all of your distribution's Nonto Font-related packages. - -- On Debian-like systems, install with: - - apt install fonts-noto-core fonts-noto-color-emoji \ - fonts-noto-extra fonts-noto-ui-core fonts-noto-ui-extra - -========================================================================== -Contact info: mailto:dianne@skoll.ca -Home page: https://dianne.skoll.ca/projects/remind/ diff --git a/README.md b/README.md new file mode 100644 index 00000000..68e745dd --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# REMIND + +Remind is a full-featured calendar/alarm program. Copying policy is +in the file "COPYRIGHT" included with the source; Remind is licensed under +the GNU General Public License, Vesion 2. + +## Prerequisites: + +`remind` and `rem2ps` have no prerequisites beyond the standard C library and +the standard math library. + +`rem2html` requires the `JSON::MaybeXS` Perl module and `rem2pdf` +requires the `JSON::MaybeXS`, `Pango` and `Cairo` Perl modules. + +- On Debian-like systems, these prerequisites may be installed with: + + `apt install libjson-maybexs-perl libpango-perl libcairo-perl` + +- On RPM-based systems, you need `perl-Pango`, `perl-Cairo` and + `perl-JSON-MaybeXS` + +- On Gentoo, you need `dev-perl/Pango`, `dev-perl/Cairo` and + `dev-perl/JSON-MaybeXS`. + +- On Arch linux, you need `pango-perl`, `cairo-perl` and `perl-json-maybexs` + +TkRemind requires Tcl/Tk and the `tcllib` library. + +- On Debian-like systems, install with: + + `apt install tcl tk tcllib` + +- On RPM-based systems, you need `tcl`, `tk` and `tcllib` + +- On Arch Linux, you need `tk` and `tcllib`. The latter is available at + https://aur.archlinux.org/packages/tcllib + +If the little arrows for "Previous Month" and "Next Month" do not display +correctly in TkRemind, you may need to install the Noto Fonts. Install +all of your distribution's Nonto Font-related packages. + +- On Debian-like systems, install with: + + `apt install fonts-noto-core fonts-noto-color-emoji fonts-noto-extra fonts-noto-ui-core fonts-noto-ui-extra` + +## Installation + +Remind can be installed with the usual: + +`./configure && make && make test && sudo make install` + +You can edit `custom.h` to configure some aspects of Remind. Or, if +you have Tcl/Tk installed, you can use the graphical build tool to +edit `custom.h` on your behalf: + +`wish ./build.tk` + +--- + +Contact info: dianne@skoll.ca + +Home page: [https://dianne.skoll.ca/projects/remind/](https://dianne.skoll.ca/projects/remind/) +