aboutsummaryrefslogtreecommitdiff
path: root/README
blob: e12f8f5655a0821d453f7d80c33e4c57159221eb (plain)
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
==========================================================================
Modular C++ Build System Template
==========================================================================
# Author  : Christopher Batten
# Date    : September 24, 2008
# Version : (under version control)

This is a template for the Modular C++ Build System. Please refer to the
following documentation for more information on the build system:

 - 'mcppbs-uguide.txt'    : Modular C++ Build System User Guide
 - 'utst/utst-uguide.txt' : Unit Testing Framework User Guide
 - 'style-guide.txt'      : C++ Coding Style Guide

Developers should eventually replace this 'README' file with information
on their new project. It is recommended that the new 'README' file keep
pointers to the above documentation so that end-users can learn about
the build system. You may also want to keep the version information
around so that you know what version of the build system you are using.

--------------------------------------------------------------------------
Template Instantiation
--------------------------------------------------------------------------

 - Update project metadata (name, maintainer, etc) in 'configure.ac'
 - Run 'autoconf && autoheader' in project's root directory
 - Add subprojects and update the list in 'configure.ac'

--------------------------------------------------------------------------
Build Steps
--------------------------------------------------------------------------

 % mkdir build
 % cd build
 % CC=riscv-gcc ../configure --prefix=$RISCV/target --host=riscv
 % make
 % make install