diff --git a/README.md b/README.md index 9529ed7..b1923b2 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,30 @@ -# doc-template -document template + [![PDF-Preview](https://img.shields.io/badge/Preview-PDF-blue)](../../releases/download/auto-pdf-preview/HiPS-draft.pdf) +# HiPS +This document presents HiPS, a hierarchical scheme for the description, storage and access of sky survey data. The system is based on hierarchical tiling of sky regions at finer and finer spatial resolution which facilitates a progressive view of a survey, and supports multi-resolution zooming and panning. HiPS is based on a HEALPix discretization of the sphere. + +## Document Status + +### Latest Stable + +The current IVOA Recommendation is [REC-1.0](https://ivoa.net/documents/HiPS/20170519/index.html). Prior versions are available on the [IVOA Documents page](https://www.ivoa.net/documents/index.html). + +### Making Changes + +Changes to this document are made via pull requests to the `master` branch of this repository. A [PDF preview](../../releases/download/auto-pdf-preview/HiPS-draft.pdf "PRE-RELEASE, DO NOT PUBLISH") of the latest `master` version is available by clicking the badge on top. + +When cloning your fork of this repository, use `--recurse-submodules` to include its submodules. + + git clone --recurse-submodules https://github.com/[your github user]/HiPS.git + +Then: run "make" and hope you have all the necessary tools installed. + +More more information, see the [ivoatex README](https://github.com/ivoa-std/ivoatex#readme) and the IVOA note [IVOATeX Document Preparation System](https://ivoa.net/documents/Notes/IVOATex/). + +## License + + +Creative Commons License +
The IVOA Architecture document is licensed under the - Creative Commons License -
- This work is licensed under a - Creative Commons Attribution-ShareAlike 4.0 International License. - +Creative Commons Attribution-ShareAlike 4.0 International License./M