LOOT now expects an index.html

That isn't present in the repository, as it should be generated using
Vulcanize. I've updated the README to reflect this.
This commit is contained in:
Oliver Hamlet
2014-11-11 21:38:40 +00:00
parent 46a177ad7c
commit ac79b63fa0
3 changed files with 12 additions and 3 deletions
+1
View File
@@ -53,3 +53,4 @@ docs/html
docs/latex
*.mo
resources/report/bower_components
resources/report/index.html
+10 -2
View File
@@ -12,6 +12,8 @@ LOOT is intended to make using mods easier, and mod users should still possess a
## Building LOOT
### C++ Backend
LOOT uses [CMake](http://cmake.org) to generate build files, and requires the following libraries (version numbers used in latest development revision given):
* [Alphanum](http://www.davekoelle.com/files/alphanum.hpp)
@@ -27,14 +29,20 @@ Alphanum and Libespm do not require any additional setup. The rest of the librar
Although LOOT uses a cross-platform build system and cross-platform libraries, it does rely on some Windows API functionality. Anyone wishing to port LOOT to other platforms will need to ensure equivalent functionality is implemented for their target platform. The Windows API code is wrapped in `#ifdef _WIN32` blocks so that it can be easily identified.
LOOT's UI also relies on a few web libraries:
### User Interface
LOOT's UI relies on a few web libraries:
* [Polymer](https://www.polymer-project.org)
* [Jed](https://github.com/SlexAxton/Jed)
* [Marked](https://github.com/chjj/marked)
* [RequireJS](http://requirejs.org/)
These dependencies are most easily managed using [Bower](http://bower.io/). To install Bower, first install [Node](http://nodejs.org/), and run `npm install -g bower` from the command line (on Windows, it needs to be the Node command prompt). Once Bower is installed, LOOT's UI dependencies can be fetched by running `bower install ./` from inside this repository's `resources/report` folder. Bower doesn't need to be run from the Node command prompt on Windows.
These dependencies are most easily managed using [Bower](http://bower.io/), and are built for distribution using [Vulcanize](https://github.com/Polymer/vulcanize).
To install Bower and Vulcanize, first install [Node](http://nodejs.org/), and run `npm install -g bower vulcanize` from the command line (on Windows, it needs to be the Node command prompt). Once they are installed, fetch and build the dependencies by running `bower install ./ && vulcanize -o index.html report.html` from inside this repository's `resources/report` folder (this command doesn't need to be run through Node).
**Note:** There is currently a bug in Vulcanize (#97) that prevents it from correctly building the dependencies, so some manual editing is required to add `<tr>` and `<td>` elements back into the row templates originally found in `resources/report/html/editable-table.html`.
## Packaging Releases
+1 -1
View File
@@ -36,7 +36,7 @@ namespace loot {
//Common paths.
const boost::filesystem::path g_path_readme = boost::filesystem::current_path() / "docs" / "LOOT Readme.html";
const boost::filesystem::path g_path_report = boost::filesystem::current_path() / "resources" / "report" / "report.html";
const boost::filesystem::path g_path_report = boost::filesystem::current_path() / "resources" / "report" / "index.html";
const boost::filesystem::path g_path_imports = boost::filesystem::current_path() / "resources" / "report";
const boost::filesystem::path g_path_l10n = boost::filesystem::current_path() / "resources" / "l10n";
#ifdef _WIN32