diff --git a/README.md b/README.md index b0b2942..106cb23 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,16 @@ To run, it requires a file named 'roads.dat', which contains road data for all o This repository requires emscripten in order to build webassembly from the C++ code in the native folder. Before you can run npm run build or npm run build:emscripten, the emcc binary needs to be added to the PATH. +## To initialize +Install all required packages by running npm ci. Next, build the WebAssembly code needed for route calculations by running npm run build:emscripten. + ## To run First, run npm run build:emscripten, then run npx vite. ## To build -Run npm run build. This will first run the emscripten build, and then the typescript build. The resulting website ends up in the dist/ folder \ No newline at end of file +Run npm run build. This will first run the emscripten build, and then the typescript build. The resulting website ends up in the dist/ folder. + +## Attributions +This library uses the [leaflet](https://leafletjs.com/) library, which is licensed under the [2-clause BSD license](https://opensource.org/license/bsd-2-clause). It also uses the [leaflet-geoman-free](https://geoman.io/docs/leaflet/) and [proj4](http://proj4js.org/) libraries, which are licensed under the [MIT license.](https://opensource.org/license/mit). It also uses typescript definitions for [leaflet](https://www.npmjs.com/package/@types/leaflet) and [geojson](https://www.npmjs.com/package/@types/geojson), which are also licensed under the [MIT license](https://opensource.org/license/mit). + +The SVG icons used for creating and deleting map areas are copied, unaltered, from [Font Awesome](https://fontawesome.com), and are licensed under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) license. The colored map markers are from the [leaflet-color-markers](https://github.com/pointhi/leaflet-color-markers) library, and are licensed under the [2-clause BSD license](https://opensource.org/license/bsd-2-clause). \ No newline at end of file diff --git a/index.html b/index.html index e59f14f..ef6dadc 100644 --- a/index.html +++ b/index.html @@ -87,6 +87,25 @@ at the top left of the map. After you've drawn the search area on the map, click the "Start search" button. A table will show a running tally of the longest routes found.
+The source code for this web site can be found here.
+ ++ This library uses the leaflet library, which is licensed under the + 2-clause BSD license. It also uses + the leaflet-geoman-free and + proj4 libraries, which are licensed under the + MIT license. +
++ The icons used for creating and deleting map areas are copied, unaltered, from + Font Awesome, and are licensed under the + Creative Commons Attribution 4.0 International + license. The colored map markers are from the + leaflet-color-markers library, and are + licensed under the 2-clause BSD license. +
+