From ef45b73cb5f01043092840635e57723325c15b41 Mon Sep 17 00:00:00 2001 From: "R. S. Doiel" Date: Tue, 20 Jun 2023 11:10:50 -0700 Subject: [PATCH] Quick Save --- INSTALL.md | 51 +++++++++++++++++++++++++++++++++++++++++++ fadein2osf.1.md | 32 +++++++++++++++++++++++++++ man/man1/fadein2osf.1 | 18 +++++++-------- osf2txt.1.md | 32 +++++++++++++++++++++++++++ txt2osf.1.md | 32 +++++++++++++++++++++++++++ version.go | 2 +- 6 files changed, 157 insertions(+), 10 deletions(-) create mode 100644 INSTALL.md create mode 100644 fadein2osf.1.md create mode 100644 osf2txt.1.md create mode 100644 txt2osf.1.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..1f3d574 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,51 @@ + +Installation +------------ + +This project is experimental. Get the latest release from [GitHub](https://github.com/rsdoiel/osf/releases/). + +Quick install with curl +----------------------- + +If you are using macOS or Linux you maybe able to install osf using the following curl command. + +~~~shell +curl https://rsdoiel.github.io/osf/installer.sh | sh +~~~ + +Install from source +------------------- + +## Requirements + +- Golang >= 1.20 +- Pandoc >= 3 +- GNU Make +- Git + +## Steps + +1. Clone the Git repository for the project +2. change directory into the cloned project +3. Run `make`, `make test` and `make install` + +Here's what that looks like for me. + +~~~ +git clone https://github.com/rsdoiel/osf src/github.com/rsdoiel/osf +cd src/github.com/rsdoiel/osf +make +make test +make install +~~~ + +By default it will install the programs in `$HOME/bin`. `$HOME/bin` needs +to be included in your `PATH`. E.g. + +~~~ +export PATH="$HOME/bin:$PATH" +~~~ + +Can be added to your `.profile`, `.bashrc` or `.zshrc` file depending on your system's shell. + + diff --git a/fadein2osf.1.md b/fadein2osf.1.md new file mode 100644 index 0000000..08e64be --- /dev/null +++ b/fadein2osf.1.md @@ -0,0 +1,32 @@ + +USAGE: fadein2osf [OPTIONS] + +DESCRIPTION + +fadein2osf is a command line program that reads an ".fadein" file +and write outs a OSF 2.0 XML. + +OPTIONS + + -generate-manpage generate man page + -generate-markdown generate Markdown documentation + -h, -help display help + -i, -input set the input filename + -l, -license display license + -nl, -newline add a trailing newline + -o, -output set the output filename + -quiet suppress error messages + -v, -version display version + + +EXAMPLES + +Convert *screenplay.fadein* into *screenplay.osf*. + + fadein2osf -i screenplay.fadein -o screenplay.osf + +Display converted OSF 2.0 XML to the console + + fadein2osf -i screenplay.fadein + +fadein2osf 0.0.4 diff --git a/man/man1/fadein2osf.1 b/man/man1/fadein2osf.1 index 35ea0e1..0c5e189 100644 --- a/man/man1/fadein2osf.1 +++ b/man/man1/fadein2osf.1 @@ -14,15 +14,15 @@ OPTIONS .IP .nf \f[C] --generate-manpage generate man page --generate-markdown generate Markdown documentation --h, -help display help --i, -input set the input filename --l, -license display license --nl, -newline add a trailing newline --o, -output set the output filename --quiet suppress error messages --v, -version display version +-generate-manpage generate man page +-generate-markdown generate Markdown documentation +-h, -help display help +-i, -input set the input filename +-l, -license display license +-nl, -newline add a trailing newline +-o, -output set the output filename +-quiet suppress error messages +-v, -version display version \f[R] .fi .PP diff --git a/osf2txt.1.md b/osf2txt.1.md new file mode 100644 index 0000000..5042f21 --- /dev/null +++ b/osf2txt.1.md @@ -0,0 +1,32 @@ + +USAGE: osf2txt [OPTIONS] + +DESCRIPTION + +osf2txt is a command line program that reads an osf file +and returns plain text + +OPTIONS + + -generate-manpage generate man page + -generate-markdown generate Markdown documentation + -h, -help display help + -i, -input set the input filename + -l, -license display license + -nl, -newline add a trailing newline + -o, -output set the output filename + -quiet suppress error messages + -v, -version display version + + +EXAMPLES + +Convert *screenplay.osf* into *screenplay.txt*. + + osf2txt -i screenplay.osf -o screenplay.txt + +Or alternatively + + cat screenplay.osf | osf2txt > screenplay.txt + +osf2txt 0.0.4 diff --git a/txt2osf.1.md b/txt2osf.1.md new file mode 100644 index 0000000..bb93243 --- /dev/null +++ b/txt2osf.1.md @@ -0,0 +1,32 @@ + +USAGE: txt2osf [OPTIONS] + +DESCRIPTION + +txt2osf is a command line program that reads an plain text file +and returns an OSF 2.0 text + +OPTIONS + + -generate-manpage generate man page + -generate-markdown generate Markdown documentation + -h, -help display help + -i, -input set the input filename + -l, -license display license + -nl, -newline add a trailing newline + -o, -output set the output filename + -quiet suppress error messages + -v, -version display version + + +EXAMPLES + +Convert *screenplay.txt* into *screenplay.osf*. + + txt2osf -i screenplay.txt -o screenplay.osf + +Or alternatively + + cat screenplay.txt | txt2osf > screenplay.osf + +txt2osf 0.0.4 diff --git a/version.go b/version.go index 114cd26..76da9d3 100644 --- a/version.go +++ b/version.go @@ -12,7 +12,7 @@ const ( ReleaseDate = "2023-06-20" // ReleaseHash, the Git hash when version.go was generated - ReleaseHash = "9c72e5f" + ReleaseHash = "21ad498" LicenseText = ` All rights reserved.