summaryrefslogtreecommitdiffstats
path: root/examples/librados/hello_world.readme
diff options
context:
space:
mode:
Diffstat (limited to 'examples/librados/hello_world.readme')
-rw-r--r--examples/librados/hello_world.readme10
1 files changed, 10 insertions, 0 deletions
diff --git a/examples/librados/hello_world.readme b/examples/librados/hello_world.readme
new file mode 100644
index 00000000000..54f89ac1a7d
--- /dev/null
+++ b/examples/librados/hello_world.readme
@@ -0,0 +1,10 @@
+This simple librados program can be built by running "make" (and cleaned up
+with "make clean"), assuming you have librados-dev already installed.
+
+And executed using
+./librados_hello_world -c ../../src/ceph.conf
+(or whatever path to a ceph.conf is appropriate to you, or
+by explicitly specifying monitors, user id, and keys).
+
+It demonstrates using librados in a non-Ceph project and the code should
+be self-explanatory. \ No newline at end of file