diff options
| author | Eric Kunze <eric.kunze@arm.com> | 2020-10-12 15:33:03 -0700 |
|---|---|---|
| committer | Eric Kunze <eric.kunze@arm.com> | 2020-10-12 17:01:24 -0700 |
| commit | 5bae9b73f5ce46fbe4360781e9c180da28bfd3cf (patch) | |
| tree | 8e9237101a1874906490428bd54c0ca5285d7c4d | |
| parent | 56b56724c1e20db875a11979cd2903bd58bd9087 (diff) | |
| download | specification-5bae9b73f5ce46fbe4360781e9c180da28bfd3cf.tar.gz | |
Add new README.md file
Contains build requirements and short instructions.
Change-Id: Id2cc62b4a88adab53b0c7314e64221936c6d55dc
Signed-off-by: Eric Kunze <eric.kunze@arm.com>
| -rw-r--r-- | README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..7b01711 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +TOSA Specification Repository
+=============
+
+This repository contains the source files for the TOSA specification.
+See the specification itself for details on the purpose and definition
+of the specification.
+
+# Build requirements
+The TOSA specification is written in asciidoc format, and has been built
+using the following tools:
+
+* Asciidoctor 1.5.5 or later ([Asciidoctor](https://asciidoctor.org))
+* Asciidoctor-pdf
+* GNU Make 4.1 or later
+
+The default `make` build creates both an html and a pdf version of the specification
+in out/html and out/pdf
+
+If only an html build is required, `make html` will build only the html file,
+and asciidoctor-pdf is not needed.
+
+If only a pdf build is required, `make pdf` will build only the pdf.
\ No newline at end of file |