Skip to content

Commit 1154111

Browse files
author
DenverM80
committed
Update README.md for cmake
1 parent 3327566 commit 1154111

File tree

1 file changed

+23
-15
lines changed

1 file changed

+23
-15
lines changed

README.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Contact Us
1010

1111
Join us at our [Google Groups](https://groups.google.com/d/forum/spectralogicds3-sdks) forum to ask questions, or see frequently asked questions.
1212

13+
Contribute
14+
==========
15+
16+
Pull requests are welcome, but first sign the [Contributor's
17+
Agreement](https://developer.spectralogic.com/contributors-agreement/)
18+
1319
Windows
1420
=======
1521

@@ -30,6 +36,8 @@ files:
3036
ds3\bin\libintl-8.dll
3137
ds3\bin\pthreadGC2.dll
3238
ds3\include\ds3.h
39+
ds3\include\ds3_string.h
40+
ds3\include\ds3_string_multimap.h
3341
ds3\lib\ds3.exp
3442
ds3\lib\ds3.lib
3543

@@ -44,12 +52,12 @@ Unix/Linux
4452

4553
For Unix/Linux we distribute the SDK as source code. The release tarballs
4654
contain a simple build script that should work on most Unix/Linux systems. The
47-
build system is currently autotools.
55+
build system is currently autotools.
4856

4957
To install cmake on Ubuntu use apt-get and install the following:
5058

5159
$ sudo apt-get install cmake
52-
60+
5361
To install cmake on CentOS use yum and install the following:
5462
$ sudo yum install cmake
5563

@@ -66,15 +74,15 @@ On Ubuntu you can install them with apt-get:
6674

6775
$ sudo apt-get install libxml2-dev
6876
$ sudo apt-get install libcurl4-openssl-dev
69-
$ sudo apt-get install libglib2.0-dev
70-
77+
$ sudo apt-get install libglib2.0-dev
78+
7179
On CentOS you can install them with yum:
7280

7381
$ sudo yum install libxml2-devel
7482
$ sudo yum install libcurl-devel
75-
$ sudo yum install glib2-devel
76-
77-
For testing you will need the boost unit test library as well.
83+
$ sudo yum install glib2-devel
84+
85+
For testing you will need the boost unit test library as well.
7886

7987
On Ubuntu this can be installed with:
8088

@@ -83,7 +91,7 @@ On Ubuntu this can be installed with:
8391
On CentOS this can be installed with:
8492

8593
$ sudo yum install boost-test
86-
94+
8795
Release Tarball
8896
---------------
8997

@@ -140,7 +148,7 @@ To build the sample, use the following commands:
140148
$ cd sample
141149
$ make deps # Builds the SDK and installs it into directory/containing/source/tree**/install**
142150
$ make
143-
151+
144152
To run it, first ensure that DS3_ACCESS_KEY, DS3_SECRET_KEY, DS3_ENDPOINT (and optionally http:proxy) are set in environment variables to match the target device. For the simulator, see [Installation Instructions] (https://developer.spectralogic.com/sim-install/)
145153

146154
$ make run-put-bulk # create "books" bucket and put files into it
@@ -222,12 +230,12 @@ The next demonstrates how to create a new bucket:
222230
int main (int args, char * argv[]) {
223231
ds3_creds * creds = ds3_create_creds("cnlhbg==","ZIjGDQAs");
224232
ds3_client * client = ds3_create_client("http://192.168.56.101:8080", creds);
225-
233+
226234
char * bucket = "books";
227235
ds3_request * create_bucket_request = ds3_init_put_bucket_request(bucket_name);
228236
ds3_error* error = ds3_put_bucket_request(client, create_bucket_request);
229237
ds3_request_free(create_bucket_request);
230-
238+
231239
if(error != NULL) {
232240
if(error->error != NULL) {
233241
printf("Failed to create bucket with error (%lu): %s\n", error->error->http_error_code, error->message->value);
@@ -241,7 +249,7 @@ int main (int args, char * argv[]) {
241249
ds3_free_creds(creds);
242250
ds3_free_client(client);
243251
return 1;
244-
}
252+
}
245253
246254
printf("Successfully created bucket: %s\n", bucket);
247255
ds3_free_creds(creds);
@@ -262,7 +270,7 @@ The following is an example of performing a get bucket:
262270
#include "ds3.h"
263271

264272
int main (int args, char * argv[]) {
265-
ds3_list_bucket_result_response* response;
273+
ds3_list_bucket_result_response* response;
266274
uint64_t i;
267275

268276
// Setup client credentials and then the actual client itself.
@@ -298,7 +306,7 @@ int main (int args, char * argv[]) {
298306
ds3_creds_free(creds);
299307
ds3_client_free(client);
300308
return 1;
301-
}
309+
}
302310

303311
if (response == NULL) {
304312
printf("Response was null\n");
@@ -325,7 +333,7 @@ int main (int args, char * argv[]) {
325333
ds3_creds_free(creds);
326334
ds3_client_free(client);
327335
ds3_cleanup();
328-
return 0;
336+
return 0;
329337
}
330338
```
331339

0 commit comments

Comments
 (0)