COGS
====

COGS lets you specify your information model in plain text.
From this model, COGS generates rich documentation and multiple representations.
Plain text specifications allow using industry-standard tools like git 
to manage collaboration.

The Convention-based Ontology Generation System (COGS) gives you a powerful,
patterns-based way to build models. COGS enables a clean separation of
concerns and gives you full control over markup for enjoyable, agile
development. COGS includes many features that enable fast, test-driven
development, allowing you to publish sophisticated models in a variety of formats.

COGS is a production framework for domain experts and groups who value 
**ease of collaboration** and **low technical barriers** for participation.

Output Formats
--------------

Publishable formats include:

* XML Schema
* OWL 2 (RDF Schema)
* OMG's UML Normative XMI 2.4.2
* OMG's UML XMI 2.5 with Diagrams and Diagram Exchange
* Sphinx HTML documentation and visualizations
* JSON Schema
* C# class library
* SVG and dot visualizations
* GraphQL schema language

Upcoming formats include:

* Class libraries for other languages

Quick Start
-----------

Get started quickly with the Quick Start guide for your platform.

========  =====================================================================
Platform  Quick Start
========  =====================================================================
Windows   :doc:`COGS Quick Start for Windows <quick-start/windows-quick-start>`
Linux     :doc:`COGS Quick Start for Linux <quick-start/linux-quick-start>`
macOS     :doc:`COGS Quick Start for macOS <quick-start/macos-quick-start>`
========  =====================================================================

Modeler's Guide
---------------

The :doc:`Modeler's Guide <modeler-guide/index>` describes the folders and files
that allow you to define your information model.

Technical Guide
---------------

The :doc:`Technical Guide <technical-guide/index>` describes the COGS
command line application, the publishers, and the technical details 
of the system.

Platforms
---------

COGS runs on Windows, Linux, and macOS on the .NET Core 2.1 platform.

https://www.microsoft.com/net/core

Legal and Licensing
-------------------

COGS is licensed under the MIT license.

.. toctree::
   :hidden:
   :caption: Contents

   quick-start/index
   modeler-guide/index
   technical-guide/index