Skip to content
This repository was archived by the owner on Apr 8, 2025. It is now read-only.

Commit 31bb409

Browse files
author
Serdar Ozler
committed
Merge pull request #16 from tamram/master
edits to readme file
2 parents 6e12434 + 0d4ae65 commit 31bb409

File tree

1 file changed

+60
-16
lines changed

1 file changed

+60
-16
lines changed

README.md

Lines changed: 60 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Azure Storage Client Library for C++
22

3-
The Azure Storage Client Library for C++ allows you to build Azure applications
4-
that take advantage of scalable cloud computing resources. Please note that this
5-
library is a CTP (Community Technology Preview) release.
3+
The Azure Storage Client Library for C++ allows you to build applications against Microsoft Azure Storage. For an overview of Azure Storage, see [Introduction to Microsoft Azure Storage](http://azure.microsoft.com/en-us/documentation/articles/storage-introduction/).
4+
5+
Note that the Azure Storage Client Library for C++ library is a CTP (Community Technology Preview) release.
66

77
# Features
88

@@ -18,32 +18,32 @@ library is a CTP (Community Technology Preview) release.
1818

1919
# Getting started
2020

21-
For the best development experience, developers should use the official Microsoft NuGet packages for libraries. NuGet packages are regularly updated with new functionality and hotfixes.
21+
For the best development experience, we recommend that developers use the official Microsoft NuGet packages for libraries. NuGet packages are regularly updated with new functionality and hotfixes.
2222
Download the [NuGet Package](http://www.nuget.org/packages/wastorage).
2323

2424
## Requirements
2525

26-
- Azure Subscription: To call Azure services, you need to first [create an account](https://account.windowsazure.com/Home/Index). Sign up for a free trial or use your MSDN subscriber benefits.
26+
To call Azure services, you must first have an Azure subscription. Sign up for a [free trial](/en-us/pricing/free-trial/) or use your [MSDN subscriber benefits](/en-us/pricing/member-offers/msdn-benefits-details/).
2727

2828
## Need Help?
2929

30-
Be sure to check out the Azure [Developer Forums on MSDN](http://go.microsoft.com/fwlink/?LinkId=234489) if you have trouble with the provided code or use StackOverflow.
30+
Be sure to check out the [Azure Storage Forum](https://social.msdn.microsoft.com/Forums/azure/en-US/home?forum=windowsazuredata) on MSDN if you need help, or use [StackOverflow](http://stackoverflow.com/questions/tagged/azure).
3131

3232
## Collaborate & Contribute
3333

3434
We gladly accept community contributions.
3535

36-
- Issues: Please report bugs using the Issues section of GitHub
37-
- Forums: Interact with the development teams on StackOverflow or the Azure Forums
38-
- Source Code Contributions: Please follow the [contribution guidelines for Azure open source](http://windowsazure.github.io/guidelines.html) that details information on onboarding as a contributor
36+
- **Issues:** Report bugs on the [Issues page](https://github.com/Azure/azure-storage-cpp/issues) in GitHub.
37+
- **Forums:** Communicate with the Azure Storage development team on the [Azure Storage Forum](https://social.msdn.microsoft.com/Forums/azure/en-US/home?forum=windowsazuredata) or [StackOverflow](http://stackoverflow.com/questions/tagged/azure).
38+
- **Source Code Contributions:** Please follow the [contribution guidelines for Azure open source](http://azure.github.io/guidelines.html) for instructions about contributing to the source project.
3939

40-
For general suggestions about Azure please use our [UserVoice forum](http://www.mygreatwindowsazureidea.com/forums/34192-windows-azure-feature-voting).
40+
For general suggestions about Azure, use our [Azure feedback forum](http://feedback.azure.com/forums/34192--general-feedback).
4141

4242
## Download & Install
4343

4444
### Via Git
4545

46-
To get the source code of the SDK via git just type:
46+
To create a local clone of the source for the Azure Storage Client Library for C++ via `git`, type:
4747

4848
```bash
4949
git clone https://github.com/Azure/azure-storage-cpp.git
@@ -52,18 +52,62 @@ cd azure-storage-cpp
5252

5353
### Via NuGet
5454

55-
To get the binaries of this library as distributed by Microsoft, ready for use
56-
within your project you can also have them installed by the package manager [NuGet](http://www.nuget.org/).
57-
Download the [NuGet Package](http://www.nuget.org/packages/wastorage).
55+
To install the binaries for the Azure Storage Client Library for C++, type the following into the [NuGet Package Manager console](http://docs.nuget.org/docs/start-here/using-the-package-manager-console):
5856

5957
`Install-Package wastorage -Pre`
6058

6159
## Dependencies
6260

6361
### C++ REST SDK
6462

65-
This library depends on the C++ REST SDK (codename "Casablanca") 2.3.0. It can be installed through [NuGet](http://www.nuget.org/packages/cpprestsdk/2.3.0) or downloaded directly from [CodePlex](http://casablanca.codeplex.com/releases/view/129408).
63+
The Azure Storage Client Library for C++ depends on the C++ REST SDK (codename "Casablanca") 2.3.0. It can be installed through [NuGet](http://www.nuget.org/packages/cpprestsdk/2.3.0) or downloaded directly from [CodePlex](http://casablanca.codeplex.com/releases/view/129408).
6664

6765
## Code Samples
6866

69-
How-Tos focused around accomplishing specific tasks are available in the [samples folder](Microsoft.WindowsAzure.Storage/samples/).
67+
How-to topics focused around accomplishing specific tasks are available in the [samples folder](https://github.com/Azure/azure-storage-cpp/tree/master/Microsoft.WindowsAzure.Storage).
68+
69+
## Getting Started on Linux
70+
As mentioned above, the Azure Storage Client Library for C++ depends on Casablanca. Follow [these instructions](https://casablanca.codeplex.com/wikipage?title=Setup%20and%20Build%20on%20Linux&referringTitle=Documentation) to compile it. Version 0.4.0 of the library depends on Casablanca version 2.3.0.
71+
72+
Once this is complete, then:
73+
74+
- Clone the project using git:
75+
```bash
76+
git clone https://github.com/Azure/azure-storage-cpp.git
77+
```
78+
The project is cloned to a folder called `azure-storage-cpp`. Always use the master branch, which contains the latest release.
79+
- Install additional dependencies:
80+
```bash
81+
sudo apt-get install libxml++2.6-dev libxml++2.6-doc uuid-dev
82+
```
83+
- Build the SDK for Release:
84+
```bash
85+
cd azure-storage-cpp/Microsoft.WIndowsAzure.Storage
86+
mkdir build.release
87+
cd build.release
88+
CASABLANCA_DIR=<path to Casablanca> CXX=g++-4.8 cmake .. -DCMAKE_BUILD_TYPE=Release
89+
make
90+
```
91+
In the above command, replace `<path to Casablanca>` to point to your local installation of Casablanca. For example, if the file `libcpprest.so` exists at location `~/Github/Casablanca/casablanca/Release/build.release/Binaries/libcpprest.so`, then your `cmake` command should be:
92+
```bash
93+
CASABLANCA_DIR=~/Github/Casablanca/casablanca CXX=g++-4.8 cmake .. -DCMAKE_BUILD_TYPE=Release
94+
```
95+
The library is generated under `azure-storage-cpp/Microsoft.WindowsAzure.Storage/build.release/Binaries/`.
96+
97+
Once you have built the library, the samples should work equally well for Windows and Linux. You can build the samples as well:
98+
```bash
99+
cd ../samples
100+
vi SamplesCommon/samples_common.h – edit this file to include your storage account name and key
101+
mkdir build.release
102+
cd build.release
103+
CASABLANCA_DIR=<path to Casablanca> CXX=g++-4.8 cmake .. -DCMAKE_BUILD_TYPE=Release
104+
Make
105+
```
106+
To run the samples:
107+
```bash
108+
cd Binaries
109+
cp ../../BlobsGettingStarted/DataFile.txt . (this is required to run the blobs sample)
110+
./samplesblobs (run the blobs sample)
111+
./samplestables (run the tables sample)
112+
./samplesqueues (run the queues sample)
113+
```

0 commit comments

Comments
 (0)