iho-ohi / S-102-Product-Specification

It is opened to develop S-102 Bathymetric Surface Product Specification. The contents of this repository are not offical publication in force, therefore please check the final version on the IHO website.
Other
29 stars 12 forks source link

image::./sources/3.0.0/images/figure-s102-logo.svg[S102_logo__signalFlagsSpellingS102,248,120]

= IHO S-102 Bathymetric Surface Product Specification

image:https://github.com/metanorma/S-102-Product-Specification/actions/workflows/generate.yml/badge.svg["Build Status", link="https://github.com/metanorma/S-102-Product-Specification/actions/workflows/generate.yml"]

This document is available in its rendered forms here:

== Purpose

This is the IHO repository for developing the next edition of the S-102 Bathymetric Surface Product Specification.

WARNING: The contents of this repository are in draft form and are not necessarily in force yet. Please refer to the final version published on the official https://iho.int[IHO] website.

== General

This repository contains the source files of S-102 standards, including:

These documents are encoded in the https://www.metanorma.org/author/topics/document-format/[Metanorma AsciiDoc format].

== Structure

sources/:: source of the S-102 documents and models

site/:: (automatically generated, in the gh-pages branch) published document.

== Usage

This repository uses metanorma to run these processes.

Please refer to https://www.metanorma.org/author/iho/authoring-guide/[Metanorma-IHO documentation] for authoring guidance.

== Installing build tools

See the https://www.metanorma.org/install/[Metanorma install] page.

== Building the document

If you have installed the build tools locally, and wish to run the locally-installed compilation tools, there is nothing further to set.

If you use a locally installed Metanorma, run:

[source,sh]

metanorma site generate

If you wish to avoid using local dependencies, use the docker version by:

[source,sh]

docker run -v "$(pwd)":/metanorma -w /metanorma -it metanorma/mn metanorma site generate

== License

See link:LICENSE.adoc[LICENSE].