diff --git a/README b/README index 22eab94..20cbd32 100644 --- a/README +++ b/README @@ -33,33 +33,25 @@ for example, the GNU C++ compiler g++. * Getting started -MUSIC can be built and installed using the generic installation -instructions found in the file INSTALL. At the top of the source -distribution directory, do: +NOTE: This project uses **Autotools** for its build system. CMake is currently not supported. +**Prerequisites:** +Before building, ensure you have the following packages installed on your system: +* `build-essential` +* `autoconf` +* `automake` +* `libtool` +* `MPI` (e.g., OpenMPI or MPICH) + +**Build and Installation Steps:** +Run the following commands from the root directory of the source distribution: + +```bash ./autogen.sh ./configure --prefix= make make install -(On some UNIX distributions you might need to run `ldconfig' or define -LD_LIBRARY_PATH: - - export LD_LIBRARY_PATH=/usr/local/lib - -for the music utility to find its library.) - -A MUSIC co-simulation is specified in a configuration file given as -the first argument to the music utility. The test subdirectory -contains a collection of examples, for example: - -cd test -mpirun -np 4 /usr/local/bin/music demo.music - -On some systems, this way of invoking a MUSIC co-simulation isn't -supported. Se blow for an alternative method. - - * Compilation and linking flags configure.ac contains mechanisms which try to identify which MPI