Commit a462420d authored by LEFEBVREJP email's avatar LEFEBVREJP email
Browse files

Updating README.md file with clone instructions.

parent 83fcbda2
# Requirements
* C compiler. gcc 4.8 tested
* Git
* CMake. 2.8.12.2 tested.
# Getting Started
* You will need to save your ssh-key in [code.ornl.gov](https://code.ornl.gov/profile/keys).
* Clone radix
`git clone git@code.ornl.gov:jap/radix.git ~/radix`
* Change directory into radix `cd ~/radix`
* Clone TriBITS
`git clone https://github.com/lefebvre/TriBITS.git TriBITS` [TriBITS documentation](https://tribits.org/doc/TribitsDevelopersGuide.html)
* Clone extra repos
`./TriBITS/tribits/ci_support/clone_extra_repos.py`
* Create a build directory
`mkdir -p ~/build/radix`
* Change into the build `cd ~/build/radix`
* Create a configuration script in ~/build/. Lets call is ../configure.sh(linux), ..\configure.bat(windows)
```
#!/bin/bash
# Linux bash file example
rm -rf CMake*
cmake \
-D CMAKE_BUILD_TYPE:STRING=RELEASE \
-D radix_ENABLE_ALL_PACKAGES:BOOL=ON \
-D radix_ENABLE_TESTS:BOOL=ON \
-G "Unix Makefiles" \
~/radix
```
```
rem Windows MinGW bat file example
del /S /Q CMake*
cmake ^
-D CMAKE_BUILD_TYPE:STRING=RELEASE ^
-D radix_ENABLE_ALL_PACKAGES:BOOL=ON ^
-D radix_ENABLE_TESTS:BOOL=ON ^
-G "MinGW Makefiles" ^
~/radix
```
* Invoke configure script in the build directory.
`../configure.sh or ..\configure.bat`
* I place the configure script in the build directory as opposed to the build/radix directory because it allows me to delete the build/radix
directory without removing my script.
Supports Markdown
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