Skip to content

Commit

Permalink
readme fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
rpwatkins committed Jul 29, 2019
1 parent 99a7213 commit fbdeebf
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion readme.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
image::https://app.fossa.com/api/projects/git%2Bgithub.com%2Frpwatkins%2Fsocrates.svg?type=shield[]

== SOCRATES

=== Easing the use of Asciidoctor to produce manuscripts.

Socrates is a front-end CLI written in Go for creating and compiling manuscripts from sets of asciidoc files. Socrates is written in Go so it produces a single executable file with no dependencies, making it easy to install and update.
Expand All @@ -9,4 +10,14 @@ Asciidoctor is a well-designed language for producing rich and complicated manus

Socrates assists in setting up a manuscript project with a default structure, adding new manuscript elements, and compiling those files into a final manuscript in PDF or HTML format.

Best of all, every file needed to construct a manuscript is entirely text, which means it can be easily versioned in Git!
Best of all, every file needed to construct a manuscript is entirely text, which means it can be easily versioned in Git!

=== Getting Started

To get started, visit the https://socratesdocs.netlify.com[Socrates Documentation] page.

=== Roadmap

* Further documentation
* More PDF and HTML styles.
* Switch to produce a chapters-only manuscript _master.adoc_ file, e.g., --chapters-only

0 comments on commit fbdeebf

Please sign in to comment.