diff options
| author | Arseny Kapoulkine <arseny.kapoulkine@gmail.com> | 2015-03-24 10:03:08 -0700 |
|---|---|---|
| committer | Arseny Kapoulkine <arseny.kapoulkine@gmail.com> | 2015-03-24 10:03:08 -0700 |
| commit | 80a8a77af46d39872426356f311b27934284e80b (patch) | |
| tree | a1d95ce1125644f30131d3a2b0e62f1001707ae8 /docs/quickstart.adoc | |
| parent | 704d27622b554b17e3055bfb3ef4d2ba1bf17a43 (diff) | |
docs: Finishing touches
It's almost done; the only remaining issue is that some section titles are too long.
Diffstat (limited to 'docs/quickstart.adoc')
| -rw-r--r-- | docs/quickstart.adoc | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/quickstart.adoc b/docs/quickstart.adoc index 9084448..4807524 100644 --- a/docs/quickstart.adoc +++ b/docs/quickstart.adoc @@ -15,12 +15,13 @@ NOTE: No documentation is perfect; neither is this one. If you find errors or om [[install]] == Installation -pugixml is distributed in source form. You can download a source distribution via one of the following links: +You can download the latest source distribution as an archive: -* https://github.com/zeux/pugixml/releases/download/v{version}/pugixml-{version}.zip -* https://github.com/zeux/pugixml/releases/download/v{version}/pugixml-{version}.tar.gz +https://github.com/zeux/pugixml/releases/download/v{version}/pugixml-{version}.zip[pugixml-{version}.zip] (Windows line endings) +/ +https://github.com/zeux/pugixml/releases/download/v{version}/pugixml-{version}.tar.gz[pugixml-{version}.tar.gz] (Unix line endings) -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 archive format - `.zip` archive has Windows line endings, `.tar.gz` archive has Unix line endings. Otherwise the files in both archives are identical. +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 complete pugixml source consists of three files - one source file, `pugixml.cpp`, and two header files, `pugixml.hpp` and `pugiconfig.hpp`. `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 `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>`). |