-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fixed character element identification
- Loading branch information
Showing
1 changed file
with
89 additions
and
216 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,293 +1,166 @@ | ||
| <!DOCTYPE html> | ||
| <html> | ||
| <html lang="en"> | ||
| <head> | ||
| <title>fountain, a Go package for working with Fountain screenplay format</title> | ||
| <link href="/css/site.css" rel="stylesheet" /> | ||
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8"> | ||
| <meta name="language" content="EN"> | ||
| <title>R. S. Doiel, Software Engineer/Analyst - INSTALL</title> | ||
|
|
||
| <link rel="stylesheet" type="text/css" href="/printfonts/print.css" media="print" /> | ||
| <link rel="stylesheet" type="text/css" href="/webfonts/fonts.css" media="screen" /> | ||
| <link rel="stylesheet" type="text/css" href="/css/site.css" media="screen" /> | ||
| <link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" /> | ||
| <link title="markdown source for page" rel="alternative" type="application/markdown" href="INSTALL.md"> | ||
| </head> | ||
| <body> | ||
| <header> | ||
| fountain, a Go package for working with Fountain screenplay format | ||
| </header> | ||
| <nav> | ||
| <ul> | ||
| <li><a href="/">Home</a></li> | ||
| <li><a href="./">README</a></li> | ||
| <li><a href="user-manual.html">User Manual</a></li> | ||
| <li><a href="license.html">LICENSE</a></li> | ||
| <li><a href="about.html">About</a></li> | ||
| <li><a href="https://github.com/rsdoiel/osf">GitHub</a></li> | ||
| </ul> | ||
| </nav> | ||
|
|
||
| <section> | ||
| <h1 id="installation"> | ||
| Installation | ||
| </h1> | ||
| <p> | ||
| <em>fountain2json</em>, <em>fountainfmt</em>, <em>fountain2html</em> are a command line programs run from a shell like Bash. You can find compiled version in the <a href="https://github.com/rsdoiel/fountain/releases/latest">releases</a> | ||
| </p> | ||
| <h2 id="compiled-version"> | ||
| Compiled version | ||
| </h2> | ||
| <p> | ||
| This is generalized instructions for a release. | ||
| </p> | ||
| <p> | ||
| Compiled versions are available for Mac OS X (x86 and M1 processors, macos-amd64, macos-arm64), Linux (x86 processor, linux-amd64), Windows (x86 processor, windows-amd64), Rapsberry Pi OS (arm7 processor, raspbian-arm7) and Pine64 (arm64 processor, linux-arm64) | ||
| </p> | ||
| <p> | ||
| VERSION_NUMBER is a <a href="http://semver.org/">symantic version number</a> (e.g. v0.1.2) | ||
| </p> | ||
| <p> | ||
| For all the released version go to the project page on Github and click latest release | ||
| </p> | ||
| <!-- <h1>INSTALL</h1> --> | ||
|
|
||
| <p>{ “title”: “fountain, a Go package for working with Fountain screenplay format” }</p> | ||
| <h1 id="installation">Installation</h1> | ||
| <p><em>fountain2json</em>, <em>fountainfmt</em>, <em>fountain2html</em> are a command line programs run from a shell like Bash. You can find compiled version in the <a href="https://github.com/rsdoiel/fountain/releases/latest">releases</a></p> | ||
| <h2 id="compiled-version">Compiled version</h2> | ||
| <p>This is generalized instructions for a release.</p> | ||
| <p>Compiled versions are available for Mac OS X (x86 and M1 processors, macos-amd64, macos-arm64), Linux (x86 processor, linux-amd64), Windows (x86 processor, windows-amd64), Rapsberry Pi OS (arm7 processor, raspbian-arm7) and Pine64 (arm64 processor, linux-arm64)</p> | ||
| <p>VERSION_NUMBER is a <a href="http://semver.org/">symantic version number</a> (e.g. v0.1.2)</p> | ||
| <p>For all the released version go to the project page on Github and click latest release</p> | ||
| <blockquote> | ||
| <p> | ||
| https://github.com/rsdoiel/fountain/releases/latest | ||
| </p> | ||
| <p>https://github.com/rsdoiel/fountain/releases/latest</p> | ||
| </blockquote> | ||
| <table> | ||
| <thead> | ||
| <tr class="header"> | ||
| <th> | ||
| Platform | ||
| </th> | ||
| <th> | ||
| Zip Filename | ||
| </th> | ||
| <th>Platform</th> | ||
| <th>Zip Filename</th> | ||
| </tr> | ||
| </thead> | ||
| <tbody> | ||
| <tr class="odd"> | ||
| <td> | ||
| Windows | ||
| </td> | ||
| <td> | ||
| fountain-VERSION_NUMBER-windows-amd64.zip | ||
| </td> | ||
| <td>Windows</td> | ||
| <td>fountain-VERSION_NUMBER-windows-amd64.zip</td> | ||
| </tr> | ||
| <tr class="even"> | ||
| <td> | ||
| Mac OS X | ||
| </td> | ||
| <td> | ||
| fountain-VERSION_NUMBER-macos-amd64.zip | ||
| </td> | ||
| <td>Mac OS X</td> | ||
| <td>fountain-VERSION_NUMBER-macos-amd64.zip</td> | ||
| </tr> | ||
| <tr class="odd"> | ||
| <td> | ||
| Mac OS X | ||
| </td> | ||
| <td> | ||
| fountain-VERSION_NUMBER-macos-arm64.zip | ||
| </td> | ||
| <td>Mac OS X</td> | ||
| <td>fountain-VERSION_NUMBER-macos-arm64.zip</td> | ||
| </tr> | ||
| <tr class="even"> | ||
| <td> | ||
| Linux/Intel | ||
| </td> | ||
| <td> | ||
| fountain-VERSION_NUMBER-linux-amd64.zip | ||
| </td> | ||
| <td>Linux/Intel</td> | ||
| <td>fountain-VERSION_NUMBER-linux-amd64.zip</td> | ||
| </tr> | ||
| <tr class="odd"> | ||
| <td> | ||
| Raspbery Pi | ||
| </td> | ||
| <td> | ||
| fountain-VERSION_NUMBER-raspbian-arm7.zip | ||
| </td> | ||
| <td>Raspbery Pi</td> | ||
| <td>fountain-VERSION_NUMBER-raspbian-arm7.zip</td> | ||
| </tr> | ||
| <tr class="even"> | ||
| <td> | ||
| Pine64 | ||
| </td> | ||
| <td> | ||
| fountain-VERSION_NUMBER-linux-arm64.zip | ||
| </td> | ||
| <td>Pine64</td> | ||
| <td>fountain-VERSION_NUMBER-linux-arm64.zip</td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| <h2 id="the-basic-recipe"> | ||
| The basic recipe | ||
| </h2> | ||
| <h2 id="the-basic-recipe">The basic recipe</h2> | ||
| <ul> | ||
| <li> | ||
| Find the Zip file listed matching the architecture you’re running and download it | ||
| <li>Find the Zip file listed matching the architecture you’re running and download it | ||
| <ul> | ||
| <li> | ||
| (e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style CPU you’d choose the Zip file with “windows-amd64” in the name). | ||
| </li> | ||
| </ul> | ||
| <li>(e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style CPU you’d choose the Zip file with “windows-amd64” in the name).</li> | ||
| </ul></li> | ||
| <li>Download the zip file and unzip the file.<br /> | ||
| </li> | ||
| <li> | ||
| Download the zip file and unzip the file.<br /> | ||
| </li> | ||
| <li> | ||
| Copy the contents of the folder named “bin” to a folder that is in your path | ||
| <li>Copy the contents of the folder named “bin” to a folder that is in your path | ||
| <ul> | ||
| <li> | ||
| (e.g. “$HOME/bin” is common). | ||
| </li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| Adjust your PATH if needed | ||
| <li>(e.g. “$HOME/bin” is common).</li> | ||
| </ul></li> | ||
| <li>Adjust your PATH if needed | ||
| <ul> | ||
| <li> | ||
| (e.g. export PATH=“<span class="math inline"><em>H</em><em>O</em><em>M</em><em>E</em>/<em>b</em><em>i</em><em>n</em>:</span>PATH”) | ||
| </li> | ||
| <li>(e.g. export PATH=“<span class="math inline"><em>H</em><em>O</em><em>M</em><em>E</em>/<em>b</em><em>i</em><em>n</em>:</span>PATH”)</li> | ||
| </ul></li> | ||
| <li>Test</li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| Test | ||
| </li> | ||
| </ul> | ||
| <h3 id="mac-os-x"> | ||
| Mac OS X | ||
| </h3> | ||
| <h3 id="mac-os-x">Mac OS X</h3> | ||
| <ol type="1"> | ||
| <li> | ||
| Download the zip file | ||
| </li> | ||
| <li> | ||
| Unzip the zip file | ||
| </li> | ||
| <li> | ||
| Copy the executables to $HOME/bin (or a folder in your path) | ||
| </li> | ||
| <li> | ||
| Make sure the new location in in our path | ||
| </li> | ||
| <li> | ||
| Test | ||
| </li> | ||
| <li>Download the zip file</li> | ||
| <li>Unzip the zip file</li> | ||
| <li>Copy the executables to $HOME/bin (or a folder in your path)</li> | ||
| <li>Make sure the new location in in our path</li> | ||
| <li>Test</li> | ||
| </ol> | ||
| <p> | ||
| Here’s an example of the commands run in the Terminal App after downloading the zip file. | ||
| </p> | ||
| <p>Here’s an example of the commands run in the Terminal App after downloading the zip file.</p> | ||
| <pre class="shell"><code> cd Downloads/ | ||
| unzip fountain-*-macos-amd64.zip | ||
| mkdir -p $HOME/bin | ||
| cp -v bin/* $HOME/bin/ | ||
| export PATH=$HOME/bin:$PATH | ||
| fountain -version</code></pre> | ||
| <h3 id="windows"> | ||
| Windows | ||
| </h3> | ||
| <h3 id="windows">Windows</h3> | ||
| <ol type="1"> | ||
| <li> | ||
| Download the zip file | ||
| </li> | ||
| <li> | ||
| Unzip the zip file | ||
| </li> | ||
| <li> | ||
| Copy the executables to $HOME/bin (or a folder in your path) | ||
| </li> | ||
| <li> | ||
| Test | ||
| </li> | ||
| <li>Download the zip file</li> | ||
| <li>Unzip the zip file</li> | ||
| <li>Copy the executables to $HOME/bin (or a folder in your path)</li> | ||
| <li>Test</li> | ||
| </ol> | ||
| <p> | ||
| Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file. | ||
| </p> | ||
| <p>Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file.</p> | ||
| <pre class="shell"><code> cd Downloads/ | ||
| unzip fountain-*-windows-amd64.zip | ||
| mkdir -p $HOME/bin | ||
| cp -v bin/* $HOME/bin/ | ||
| export PATH=$HOME/bin:$PATH | ||
| fountain -version</code></pre> | ||
| <h3 id="linux"> | ||
| Linux | ||
| </h3> | ||
| <h3 id="linux">Linux</h3> | ||
| <ol type="1"> | ||
| <li> | ||
| Download the zip file | ||
| </li> | ||
| <li> | ||
| Unzip the zip file | ||
| </li> | ||
| <li> | ||
| Copy the executables to $HOME/bin (or a folder in your path) | ||
| </li> | ||
| <li> | ||
| Test | ||
| </li> | ||
| <li>Download the zip file</li> | ||
| <li>Unzip the zip file</li> | ||
| <li>Copy the executables to $HOME/bin (or a folder in your path)</li> | ||
| <li>Test</li> | ||
| </ol> | ||
| <p> | ||
| Here’s an example of the commands run in from the Bash shell after downloading the zip file. | ||
| </p> | ||
| <p>Here’s an example of the commands run in from the Bash shell after downloading the zip file.</p> | ||
| <pre class="shell"><code> cd Downloads/ | ||
| unzip fountain-*-linux-amd64.zip | ||
| mkdir -p $HOME/bin | ||
| cp -v bin/* $HOME/bin/ | ||
| export PATH=$HOME/bin:$PATH | ||
| fountain -version</code></pre> | ||
| <h3 id="raspberry-pi"> | ||
| Raspberry Pi | ||
| </h3> | ||
| <p> | ||
| Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support). | ||
| </p> | ||
| <h3 id="raspberry-pi">Raspberry Pi</h3> | ||
| <p>Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).</p> | ||
| <ol type="1"> | ||
| <li> | ||
| Download the zip file | ||
| </li> | ||
| <li> | ||
| Unzip the zip file | ||
| </li> | ||
| <li> | ||
| Copy the executables to $HOME/bin (or a folder in your path) | ||
| </li> | ||
| <li> | ||
| Test | ||
| </li> | ||
| <li>Download the zip file</li> | ||
| <li>Unzip the zip file</li> | ||
| <li>Copy the executables to $HOME/bin (or a folder in your path)</li> | ||
| <li>Test</li> | ||
| </ol> | ||
| <p> | ||
| Here’s an example of the commands run in from the Bash shell after downloading the zip file. | ||
| </p> | ||
| <p>Here’s an example of the commands run in from the Bash shell after downloading the zip file.</p> | ||
| <pre class="shell"><code> cd Downloads/ | ||
| unzip fountain-*-raspbian-arm7.zip | ||
| mkdir -p $HOME/bin | ||
| cp -v bin/* $HOME/bin/ | ||
| export PATH=$HOME/bin:$PATH | ||
| fountain -version</code></pre> | ||
| <h2 id="compiling-from-source"> | ||
| Compiling from source | ||
| </h2> | ||
| <p> | ||
| The <em>fountain</em> command line programs are “go gettable”. Use the “go get” command to download the dependant packages as well as source code. | ||
| </p> | ||
| <h2 id="compiling-from-source">Compiling from source</h2> | ||
| <p>The <em>fountain</em> command line programs are “go gettable”. Use the “go get” command to download the dependant packages as well as source code.</p> | ||
| <pre class="shell"><code> go get -u github.com/rsdoiel/fountain/...</code></pre> | ||
| <p> | ||
| Or clone the repstory and then compile | ||
| </p> | ||
| <p>Or clone the repstory and then compile</p> | ||
| <pre class="shell"><code> cd | ||
| git clone https://github.com/rsdoiel/fountain src/github.com/rsdoiel/fountain | ||
| cd src/github.com/rsdoiel/fountain | ||
| make | ||
| make test | ||
| make install</code></pre> | ||
| </section> | ||
| <nav> | ||
| <ul> | ||
| <li> | ||
| <a href="/">Home</a> | ||
| </li> | ||
| <li> | ||
| <a href="./">README</a> | ||
| </li> | ||
| <li> | ||
| <a href="license.html">LICENSE</a> | ||
| </li> | ||
| <li> | ||
| <a href="install.html">INSTALL</a> | ||
| </li> | ||
| <li> | ||
| <a href="docs/">Documentation</a> | ||
| </li> | ||
| <li> | ||
| <a href="testdata.html">Test Data</a> | ||
| </li> | ||
| <li> | ||
| <a href="https://github.com/rsdoiel/fountain">GitHub</a> | ||
| </li> | ||
| </ul> | ||
| </nav> | ||
|
|
||
| <footer> | ||
| copyright (c) 2021 all rights reserved. | ||
| Released under the BSD 2-Clause license | ||
| See: http://opensource.org/licenses/BSD-2-Clause | ||
| </footer> | ||
|
|
||
| </body> | ||
| </html> |