Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/windirstat/llfio.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiall Douglas (s [underscore] sourceforge {at} nedprod [dot] com) <spamtrap@nedprod.com>2021-04-15 13:37:07 +0300
committerNiall Douglas (s [underscore] sourceforge {at} nedprod [dot] com) <spamtrap@nedprod.com>2021-04-15 13:37:07 +0300
commitdb383d69b71ae5dab99e8e90699629c1a684f4ee (patch)
tree5cf5803690157aa8c2382257292b687064112165 /Build.md
parent2040dcb520d92328a9318b948c380e1692f41249 (diff)
Merge https://github.com/ned14/llfio/pull/77 into my current working tree and push the bits which are safe to push for now.
Diffstat (limited to 'Build.md')
-rw-r--r--Build.md80
1 files changed, 42 insertions, 38 deletions
diff --git a/Build.md b/Build.md
index 6325a75e..9ccb6176 100644
--- a/Build.md
+++ b/Build.md
@@ -9,41 +9,9 @@ These compilers and OSs are regularly tested:
Other compilers, architectures and OSs may work, but are not tested regularly.
You will need a working [Filesystem TS](https://en.cppreference.com/w/cpp/experimental/fs)
-implementation in your STL, and at least C++ 14.
-
-## Get a copy of the source
-
-Download [this archive](https://dedi5.nedprod.com/static/files/llfio-v2-source-latest.tar.xz)
-or clone from the GitHub repository:
-
-~~~
-git config --system core.longpaths true
-git clone --recursive https://github.com/ned14/llfio.git
-cd llfio
-~~~
-
-The first command is relevant so deeply nested paths on Windows will work when
-cloning the repository and submodules. It may require elevated privileges, but
-you can also use `git config --global core.longpaths true` instead.
-
-### If you already cloned before reading this
-
-If you had already cloned _this_ repository, but didn't use the `--recursive`
-switch, you can simply run the following command from inside the work tree:
-
-~~~
-git submodule update --init --recursive
-~~~
-
-## Header only usage
-
-LLFIO defaults to header only library configuration, so you don't actually need
-any of the prebuilt binaries below, or to build anything. Simply:
-
-~~~cpp
-#include "llfio/include/llfio.hpp"
-~~~
+implementation in your STL, and at least C++ 14.
+LLFIO has your choice of header-only, static library, and shared library build modes.
Note that on Microsoft Windows, the default header only configuration is unsafe
to use outside of toy projects. You will get warnings of the form:
@@ -67,14 +35,50 @@ which doesn't have this problem (define `LLFIO_EXPERIMENTAL_STATUS_CODE=1`)
documentation](https://github.com/ned14/ntkernel-error-category)) (iii)
Don't use header only LLFIO on Windows (see below).
+
+## Install from the vcpkg package manager
+
+This is particularly easy, and works on Mac OS, Linux and Microsoft Windows:
+
+```
+vcpkg install llfio
+```
+
+LLFIO appears at `<llfio/llfio.hpp>`.
+
## Prebuilt binaries
It is faster to build programs using LLFIO if you don't use a header only build.
-In this situation, define `LLFIO_HEADERS_ONLY=0`, and choose one of `LLFIO_DYN_LINK` or `LLFIO_STATIC_LINK` depending on whether you are using the prebuilt shared or static libraries respectively.
+In this situation, define `LLFIO_HEADERS_ONLY=0`, and choose one of `LLFIO_DYN_LINK`
+or `LLFIO_STATIC_LINK` depending on whether you are using the prebuilt shared or
+static libraries respectively.
+
+You can find prebuilt binaries for Mac OS, Ubuntu and Microsoft Windows at
+https://github.com/ned14/llfio/releases. Choose a release, and under the Assets
+you will find the prebuilt binaries packages which include headers.
+
+## Get a copy of the source
+
+Clone from the GitHub repository:
+
+~~~
+git config --system core.longpaths true
+git clone --recursive https://github.com/ned14/llfio.git
+cd llfio
+~~~
+
+The first command is relevant so deeply nested paths on Windows will work when
+cloning the repository and submodules. It may require elevated privileges, but
+you can also use `git config --global core.longpaths true` instead.
+
+### If you already cloned before reading this
-- https://dedi5.nedprod.com/static/files/llfio-v2-binaries-darwin-latest.zip
-- https://dedi5.nedprod.com/static/files/llfio-v2-binaries-linux64-latest.tgz
-- https://dedi5.nedprod.com/static/files/llfio-v2-binaries-win64-latest.zip
+If you had already cloned _this_ repository, but didn't use the `--recursive`
+switch, you can simply run the following command from inside the work tree:
+
+~~~
+git submodule update --init --recursive
+~~~
## Build static libraries from source