diff options
author | Jonas Smedegaard <dr@jones.dk> | 2018-01-04 22:27:35 +0100 |
---|---|---|
committer | Jonas Smedegaard <dr@jones.dk> | 2018-01-04 22:27:35 +0100 |
commit | dcebcc6b1b5b03f7fd37864ded04fabdba0a0b57 (patch) | |
tree | 7c21a296f649d7453fa749c88386d56eb665ba72 /README.md |
Initial draft.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..ff6d93a --- /dev/null +++ b/README.md @@ -0,0 +1,51 @@ +# Maps + +This project produces a set of slippy maps. + + +## Overview + +This document provides a broad overview of the project. + +For detailed information, +please consult these additional documents: + + * <USE.md> - ways to use of the project as-is, and their requirements + * <TODO.md> - future tasks and ideas + * <LICENSE.md> - copyright and licensing info + +Also, each source file - +in particular the scripts below <bin> - +contain specific notes on use and requirements at the top of the file. + + +## Usage + +When needed software is installed +a web service can be started +and the visualizations accessed from a web browser. + +A minimal web service is included +ready to use for quick preview. +For large-scale publication +a production quality service like Apache Httpd is recommended. + +See file <USE.md> for detailed information +on ways to use of the project as-is, and their requirements. + + +## Rights + +See file <LICENSE.md> for detailed copyright and licensing info. + +Please do not hesitate to ask if in doubt. + + +## Contact + +Main developer: Jonas Smedegaard <dr@jones.dk>. + +We would love to hear from you, +whether about uses and reuses of the project, +interest in helping out to improve some things, +or just excitement or scepticism, or whatever :-) |