Skip to content

Latest commit

 

History

History
25 lines (13 loc) · 1.78 KB

OmniDev_GettingStarted.adoc

File metadata and controls

25 lines (13 loc) · 1.78 KB

Getting Started with Omni Development

Welcome

Welcome to the Omni Layer project. This document will provide information for how you can contribute to Omni by directly contributing to the Omni Layer project or by developing software or Omni tokens in the Omni ecosystem.

Contributing to Omni Documentation

Contributions to documentation are always welcome.

Working with Asciidoctor format

Omni documentation is increasingly being created and edited in the AsciiDoc format. AsciiDoc is a powerful markdown format especially suited for software project documentation.

If you’re migrating from Github Markdown (.md format), AsciiDoc vs Markdown is a very helpful document, especially the Comparison by example section.

The easiest way to make small changes is to edit the file directly on Github. Github supports AsciiDoctor directly so to edit this file, you can click the following link: edit OmniDev_GettingStarted.adoc.

If you want to check the file out with Git and edit locally you can use any text editor and preview in your web browser using one of the Asciidoctor Live Preview plugins:

There are many other tools and toolchains that support Asciidoctor, but the above are the easiest to get started with.