From 006ed15846f0231ed3df431e9a988546f26f7625 Mon Sep 17 00:00:00 2001 From: Roger <11964962+arcataroger@users.noreply.github.com> Date: Wed, 24 Mar 2021 09:17:32 -0700 Subject: [PATCH] Cleaned up readme for open-source release --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4e08516..3266a22 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# tfm_map_openlayers +# openlayers_indoor_map Example of an interactive, indoor museum map built by the Field Museum using OpenLayers 6.5 and QGIS 3.16. This is an alpha release, meant more as an example of how to use OpenLayers to do indoor venue mapping. It's far from a complete project, and the codebase is messy and ugly. We hope to clean it up more and more over time, but in the meantime, at least it mostly works... @@ -53,7 +53,6 @@ index.css - Styling for the UI (buttons, logo, etc.) assets/ - Source files for our assets cms/ - Content (colors, descriptions, links, etc.) for our points of interest. A JSON dump from Contentful. - fonts/ - Webfonts (excluded due to copyright) icons/ - SVG icons used for amenities and pictograms images/ - UI images used in index.html layers/ - Floor source files (tif, png), outputs (geoJSON), and QGIS project @@ -130,4 +129,4 @@ Documentation for these will come later. For the most part, they are self-explan ## Misc technical / behind the scenes * The floor switcher uses its own code to hide/show floors, instead of `switchFloors()`. `ol-layer-switcher` doesn't have any hooks/events we can tie into. -* We manipulate the DOM directly, such as for updating the sidebar. We opted not to use React or similar in order to minimize the download size for users who already have to grab a lot of assets (layers, pictures, fonts, etc.). \ No newline at end of file +* We manipulate the DOM directly, such as for updating the sidebar. We opted not to use React or similar in order to minimize the download size for users who already have to grab a lot of assets (layers, pictures, fonts, etc.).