From 02fe9f70d2fa2497b5cb002249892c1cc8e2a931 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sun, 14 Aug 2016 09:45:11 +0100 Subject: [PATCH] Add a readme file for the API That links to the online documentation. --- docs/api/README.md | 13 +++++++++++++ scripts/archive.js | 9 ++++----- 2 files changed, 17 insertions(+), 5 deletions(-) create mode 100644 docs/api/README.md diff --git a/docs/api/README.md b/docs/api/README.md new file mode 100644 index 00000000..e2a56f02 --- /dev/null +++ b/docs/api/README.md @@ -0,0 +1,13 @@ +LOOT API +======== + +This archive contains a 32-bit Windows build of the LOOT API and its include +headers and linking library. The DLL requires the [MSVC 2015 x86 redistributable](https://download.microsoft.com/download/9/3/F/93FCF1E7-E6A4-478B-96E7-D4B285925B00/vc_redist.x86.exe) +to be installed. + +See the [online documentation](http://loot.readthedocs.io/) for more information. +The library source code is available [on GitHub](https://github.com/loot/loot). + +--- + +Copyright (C) 2013-2016 WrinklyNinja diff --git a/scripts/archive.js b/scripts/archive.js index afb21df1..2035802c 100644 --- a/scripts/archive.js +++ b/scripts/archive.js @@ -191,18 +191,17 @@ function createApiArchive(rootPath, releasePath, tempPath, destPath) { ); }); - // API header file. + // API header files. fs.mkdirsSync(path.join(tempPath, 'include')); fs.copySync( path.join(rootPath, 'include', 'loot'), path.join(tempPath, 'include', 'loot') ); - // Docs. - fs.mkdirsSync(path.join(tempPath, 'docs')); + // Readme. fs.copySync( - path.join(rootPath, 'docs', 'licenses'), - path.join(tempPath, 'docs', 'licenses') + path.join(rootPath, 'docs', 'api', 'README.md'), + path.join(tempPath, 'README.md') ); // Now compress the folder to a 7-zip archive.