-============================================
-Ceph - a scalable distributed storage system
-============================================
+# Ceph - a scalable distributed storage system
Please see http://ceph.com/ for current info.
-Contributing Code
-=================
+## Contributing Code
Most of Ceph is licensed under the LGPL version 2.1. Some
miscellaneous code is under BSD-style license or is public domain.
contributed under the terms of the applicable license.
-Checking out the source
-=======================
+## Checking out the source
You can clone from github with
git submodule update --init --recursive
-Build Prerequisites
-===================
+## Build Prerequisites
The list of Debian or RPM packages dependencies can be installed with:
./install-deps.sh
-Building Ceph
-=============
+## Building Ceph
Note that these instructions are meant for developers who are
compiling the code for development and testing. To build binaries
make install
-CMake Options
--------------
+### CMake Options
If you run the `cmake` command by hand, there are many options you can
set with "-D". For example the option to build the RADOS Gateway is
'never'.
-Building a source tarball
-=========================
+## Building a source tarball
To build a complete source tarball with everything needed to build from
source and/or build a (deb or rpm) package, run
are committed to git.)
-Running a test cluster
-======================
+## Running a test cluster
To run a functional test cluster,
./bin/init-ceph stop
-Running unit tests
-==================
+## Running unit tests
To build and run all tests (in parallel using all processors), use `ctest`:
man ctest
-Building the Documentation
-==========================
+## Building the Documentation
-Prerequisites
--------------
+### Prerequisites
The list of package dependencies for building the documentation can be
found in doc_deps.deb.txt:
sudo apt-get install `cat doc_deps.deb.txt`
-Building the Documentation
---------------------------
+### Building the Documentation
To build the documentation, ensure that you are in the top-level
`/ceph directory, and execute the build script. For example: