Changeset 660665f for INSTALL

Timestamp:

Jun 29, 2021, 5:35:19 PM (5 years ago)

Author:

caparsons <caparson@…>

Branches:

ADT, ast-experimental, enum, forall-pointer-decay, jacob/cs343-translation, master, new-ast-unique-expr, pthread-emulation, qualifiedEnum

Children:

dcad80a

Parents:

5a46e09 (diff), d02e547 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

Message:

Merge branch 'master' of plg.uwaterloo.ca:software/cfa/cfa-cc

File:

• INSTALL (modified) (1 diff)

INSTALL

@@ -1 @@
-cfa-cc: The Cforall->C Compiler System
+cfa-cc: Cforall to C Trans-compiler
 ======================================
 
 Cforall is built using GNU Make and the GNU Autoconf system.  It also requires
-g++ version >= 4.6, bison and flex.  On systems where GNU Make is the default
+g++ version >= 6, bison and flex.  On systems where GNU Make is the default
 make, the system is built by entering the commands:
 
-For devs using the root git:
+For developers using the root git:
 
-  ./autogen.sh
-        ./configure
-        make
-        make install
+  $ ./autogen.sh
+  $ ./configure [ --prefix=/some/directory ]
+  $ make -j 8 install
 
-For users using the distributed tarball:
+For users using the distributed tarball / github:
 
-        ./configure
-        make
-        make install
+  $ ./configure
+  $ make -j 8 install
 
-Options for 'configure'
------------------------
-The script 'configure' accepts many command line arguments.  Run './configure
---help' to see a list of all of them.  This document attempts to summarize the
-most useful arguments.
+where 8 is the number of CPUs on your computer.
 
---prefix=/some/directory controls the path prefix common to all installed
-  cfa-cc components.  Some components are installed in /some/directory/bin,
-  others in /some/directory/lib.  If unspecified, this defaults to /usr/local.
-  To use (a subdirectory of) your home directory, ${HOME}/some/dir works, but
-  it is important not to put quotes around the directory path; Cforall may
-  appear to build, but the installed version may not work properly.
+
+Options for configure
+======================================
+The script 'configure' accepts many command-line arguments.  Run
+
+  $ ./configure --help
+
+to list them.  The most common argument is:
+
+  --prefix=/some/directory controls the path prefix common to all installed
+    cfa-cc components.  Components are installed in directories bin and lib.
+    If unspecified, prefix defaults to /usr/local.  To use (a subdirectory of)
+    your home directory, ${HOME}/some/dir, but do not put quotes around the
+    directory path; Cforall may appear to build, but the installed version may
+    not work properly.
+
+
+Build Test
+======================================
+
+  $ cd ./test
+  $ make -j 8 all-tests
+
+The tests take about 2-5 minutes and can be stopped at any time.