Commit 6e1c1724 authored by David E. DeMarle's avatar David E. DeMarle

Merge branch 'add-readme' into 'master'

Added a top-level README.md file in Markdown format.

Added a `README.md` file in Markdown format. This file contains brief instructions to build XDMF from source code. The contents of this file are displayed on the project page at Gitlab. Additional documentation for new users may be added to this file in the future. 

@demarle

See merge request !4
parents 1819d6ae e11cb9e0
Installing XDMF
===============
Brief instructions for building XDMF from source code:
* Clone the git repository:
```sh
git clone git://xdmf.org/Xdmf.git
```
* Create a directory for building the code:
```sh
cd Xdmf
mkdir build
cd build
```
* Prepare the CMake-based build. There are two options:
1. Use the following command and select options using a menu.
```sh
ccmake ..
```
2. Set options on the command line. A typical command line for building
XDMF with Python bindings may look like the following:
```sh
export XDMF_INSTALL_DIR=/opt/Xdmf/
cmake .. -DCMAKE_INSTALL_PREFIX=${XDMF_INSTALL_DIR} \
-DBUILD_SHARED_LIBS=1 -DXDMF_WRAP_PYTHON=1 -Wno-dev
```
* Build and install XDMF:
```sh
make
make install
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment