Contents

= stepmod-utils Ruby gem

image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
image:https://github.com/metanorma/stepmod-utils/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/stepmod-utils/actions?query=workflow%3Aubuntu"]
image:https://github.com/metanorma/stepmod-utils/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/stepmod-utils/actions?query=workflow%3Amacos"]
image:https://github.com/metanorma/stepmod-utils/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/stepmod-utils/actions?query=workflow%3Awindows"]
image:https://codeclimate.com/github/metanorma/stepmod-utils/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/stepmod-utils"]
image:https://img.shields.io/github/issues-pr-raw/metanorma/stepmod-utils.svg["Pull Requests", link="https://github.com/metanorma/stepmod-utils/pulls"]
image:https://img.shields.io/github/commits-since/metanorma/stepmod-utils/latest.svg["Commits since latest",link="https://github.com/metanorma/stepmod-utils/releases"]

== Purpose

The stepmod-utils Ruby gem provides a number of tools to work with the STEPmod repository/

== Installation

[source,ruby]
----
gem install stepmod-utils
----

Or include it in your gemspec.

== Usage

[source,sh]
----
# Extracts from current directory
$ stepmod-extract-terms

# Extracts from specified stepmod/ or stepmod/data/ directory
$ stepmod-extract-terms {stepmod-data-directory}
----

Then these files will be created:

* `031-generated-terms.adoc` all terms extracted
* `991-generated-bibliography.adoc` all bibliographic sources where the terms come from

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
stepmod-utils-0.1.8	README.adoc
stepmod-utils-0.1.7	README.adoc
stepmod-utils-0.1.6	README.adoc
stepmod-utils-0.1.5	README.adoc