summaryrefslogtreecommitdiff
path: root/docs/quickstart.qbk
diff options
context:
space:
mode:
authorarseny.kapoulkine <arseny.kapoulkine@99668b35-9821-0410-8761-19e4c4f06640>2010-07-21 07:39:30 +0000
committerarseny.kapoulkine <arseny.kapoulkine@99668b35-9821-0410-8761-19e4c4f06640>2010-07-21 07:39:30 +0000
commitb4a012a4d5bf2ab4da5a59f448095d18f04a77b0 (patch)
tree087d2e08bf96b3241dd10977b9fe7a4bb0736e99 /docs/quickstart.qbk
parent18638d7ce0f5a825917f5fb3a93479d5f8ab301f (diff)
docs: Added line endings information
git-svn-id: http://pugixml.googlecode.com/svn/trunk@609 99668b35-9821-0410-8761-19e4c4f06640
Diffstat (limited to 'docs/quickstart.qbk')
-rw-r--r--docs/quickstart.qbk2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/quickstart.qbk b/docs/quickstart.qbk
index 2199b37..d28d2e3 100644
--- a/docs/quickstart.qbk
+++ b/docs/quickstart.qbk
@@ -34,7 +34,7 @@ pugixml is distributed in source form. You can download a source distribution vi
[@http://pugixml.googlecode.com/files/pugixml-0.9.tar.gz]
]
-The distribution contains library source, documentation (the guide you're reading now and the manual) and some code examples. After downloading the distribution, install pugixml by extracting all files from the compressed archive.
+The distribution contains library source, documentation (the guide you're reading now and the manual) and some code examples. After downloading the distribution, install pugixml by extracting all files from the compressed archive. The files have different line endings depending on the format - [file .zip] archive has Windows line endings, [file .tar.gz] archive has Unix line endings. Otherwise the files in both archives are identical.
The complete pugixml source consists of four files - two source files, [file pugixml.cpp] and [file pugixpath.cpp], and two header files, [file pugixml.hpp] and [file pugiconfig.hpp]. [file pugixml.hpp] is the primary header which you need to include in order to use pugixml classes/functions. The rest of this guide assumes that [file pugixml.hpp] is either in the current directory or in one of include directories of your projects, so that `#include "pugixml.hpp"` can find the header; however you can also use relative path (i.e. `#include "../libs/pugixml/src/pugixml.hpp"`) or include directory-relative path (i.e. `#include <xml/thirdparty/pugixml/src/pugixml.hpp>`).