Add a readme file for the API

That links to the online documentation.
This commit is contained in:
Oliver Hamlet
2016-08-24 08:08:15 +01:00
parent ec018387ac
commit 02fe9f70d2
2 changed files with 17 additions and 5 deletions
+13
View File
@@ -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
+4 -5
View File
@@ -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.