Add cmake scripts, update documents

Author: xiota

CMakeLists.txt

@@ -0,0 +1,9 @@
+cmake_minimum_required(VERSION 3.5)
+
+project(ftn2xml VERSION 0.1.0)
+
+find_package(podofo REQUIRED)
+
+option(VERSION "Project version" ${CMAKE_PROJECT_VERSION})
+
+add_subdirectory(src)

Fountain_Syntax.md

@@ -21,6 +21,7 @@ The official description of standard Fountain is available at [Fountain.io](http
 * Characters are in all upper case.
   - They may be forced with `@`
   - There may be a same-line parenthetical.
+  - Trailing `^` indicates simultaneous or dual dialog.
 * Dialog speech follows Character or Parenthetical.
 * Parentheticals follow Character or Speech.  They are surrounded with `(` and `)`.
 * Bold text is indicated with `**`

Readme.md

@@ -1,4 +1,4 @@
-# Fountain Screenplay Processor
+# Fountain Screenplay Processor (`ftn2xml`)
 
 This library converts Fountain screenplay documents into XML-style documents with tags that can be converted to other markup languages, like HTML or FDX.  Some command-line utilities are provided to demonstrate use, including PDF conversion using PoDoFo.
 
@@ -19,21 +19,18 @@ A detailed description of standard Fountain is available at [Fountain.io](https:
 
 ## Usage (command line)
 
-Basic command line utilities are provided:
+Some basic command line utilities are provided:
 
 * `ftn2xml` – Convert to native XML-style format.
 * `ftn2html` – Convert to native HTML-style format.
 * `ftn2pdf` – Export to PDF using PoDoFo library.
 * `ftn2fdx` – Convert into Final Draft document.
 
-To use:
+Use the binary or symlink that corresponds to the desired conversion.
 
-1. Build by running `make` from within the `src` directory.
-2. Move the binary and symlinks into your `PATH`.
-3. Use the binary or symlink that corresponds to the desired conversion.
-   * First argument is the fountain input file.
-   * Second argument, if present, is the output file.  Required for PDF output.
-   * If only one argument is given, output is to `stdout`.
+* First argument is the fountain input file.
+* Second argument, if present, is the output file.  Required for PDF output.
+* If only one argument is given, output is to `stdout`.
 
 ## Usage (source code)
 
@@ -52,9 +49,19 @@ To use:
 
 * Compiler that supports C++17 standard.  Both `clang++` and `g++` seem to work.
 * [PoDoFo](https://github.com/podofo/podofo) for PDF export.
-   - PoDoFo 0.9.x - use commit tagged [0.0.2](https://github.com/xiota/fountain-screenplay-processor/releases/tag/v0.0.2).
+   - PoDoFo 0.9.x - use commit tagged [0.0.2](releases/tag/v0.0.2).
    - PoDoFo 0.10.x - requires [Courier Prime](https://quoteunquoteapps.com/courierprime/) to work around some font issues.
 
+## Building
+
+```bash
+git clone https://github.com/xiota/ftn2xml
+cmake -B build -S ftn2xml -DCMAKE_INSTALL_PREFIX=/usr
+cmake --build build
+DESTDIR=output cmake --install
+```
+
+
 ## License
 
 This software is licensed under the GPL-3.0-or-later.

src/CMakeLists.txt

@@ -0,0 +1,29 @@
+add_executable(ftn2xml ftn2xml.cc)
+
+configure_file(ftn2xml.h.in ftn2xml.h)
+
+add_library(fountain fountain.cc auxiliary.cc)
+
+target_link_libraries(ftn2xml fountain podofo)
+
+target_include_directories(
+  ftn2xml PUBLIC
+  "${PROJECT_BINARY_DIR}"
+)
+
+install(
+  TARGETS ftn2xml
+  DESTINATION "${CMAKE_INSTALL_PREFIX}/bin"
+)
+
+file(CREATE_LINK ftn2xml "${CMAKE_CURRENT_BINARY_DIR}/ftn2fdx" SYMBOLIC)
+file(CREATE_LINK ftn2xml "${CMAKE_CURRENT_BINARY_DIR}/ftn2html" SYMBOLIC)
+file(CREATE_LINK ftn2xml "${CMAKE_CURRENT_BINARY_DIR}/ftn2pdf" SYMBOLIC)
+
+install(
+  FILES
+    "${CMAKE_CURRENT_BINARY_DIR}/ftn2fdx"
+    "${CMAKE_CURRENT_BINARY_DIR}/ftn2html"
+    "${CMAKE_CURRENT_BINARY_DIR}/ftn2pdf"
+  DESTINATION "${CMAKE_INSTALL_PREFIX}/bin"
+)

src/ftn2xml.h.in

@@ -0,0 +1,2 @@
+
+#define FTN2XML_VERSION @VERSION@