rc icon indicating copy to clipboard operation
rc copied to clipboard

missing INSTALL document

Open malikbenkirane opened this issue 7 years ago • 2 comments

Hello,

INSTALL as mentioned here is missing.

I never used autotools before and it looks like knowledge from this toolkit is required to build rc (I see Makefile.am and configure.ac files). Could you please provide some help/doc/build instructions ?

Sincerely,

malikbenkirane avatar Aug 14 '18 19:08 malikbenkirane

Assuming you're building from github, all you should need to get going is

sh bootstrap

Note that this will create INSTALL with the generic instructions. Then run the usual commands, such as

sh configure --with-edit=readline
make
make test

Obviously this needs to be written down somewhere! Perhaps README.md

TobyGoodwin avatar Aug 14 '18 21:08 TobyGoodwin

Thank you for the instructions I propose the following patch for the README

diff --git a/README b/README
index 004d5e2..32cf793 100644
--- a/README
+++ b/README
@@ -18,6 +18,11 @@ See COPYING for copying information. All files are
 
    Copyright 1991, 1999, 2001-2003, 2014, 2015 Byron Rakitzis.
 
+If you build this from the github repository, run `sh bootstrap`, it
+generates INSTALL instructions
+(alternatively `autoreconf --force --install` is enough to make all the
+tools required for rc build and installation)
+
 See INSTALL for build and installation information.
 
 The current maintainer is Toby Goodwin[1]. Please contact him with any

malikbenkirane avatar Aug 15 '18 08:08 malikbenkirane

I've added some install instruction to the README.

xyb3rt avatar Jun 11 '23 16:06 xyb3rt