Cleaned up readme for open-source release
This commit is contained in:
parent
2ba17e63e3
commit
006ed15846
|
@ -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.
|
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...
|
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
|
assets/ - Source files for our assets
|
||||||
cms/ - Content (colors, descriptions, links, etc.) for our points of interest. A JSON dump from Contentful.
|
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
|
icons/ - SVG icons used for amenities and pictograms
|
||||||
images/ - UI images used in index.html
|
images/ - UI images used in index.html
|
||||||
layers/ - Floor source files (tif, png), outputs (geoJSON), and QGIS project
|
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
|
## 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.
|
* 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.).
|
* 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.).
|
||||||
|
|
Loading…
Reference in New Issue