Skip to content

Commit

Permalink
Merge branch 'main' of github.com:rsdoiel/scripttool into gh-pages
Browse files Browse the repository at this point in the history
  • Loading branch information
R. S. Doiel committed May 20, 2024
2 parents b5cdc5c + 97d9684 commit 1f4123a
Show file tree
Hide file tree
Showing 145 changed files with 2,967 additions and 7,358 deletions.
13 changes: 7 additions & 6 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@
bin/
dist/
testout/
testdata/Big%20Fish.fdx
testdata/Big%20Fish.fountain
testdata/Brick%20&%20Steel.fdx
testdata/Brick%20&%20Steel.fountain
testdata/The%20Last%20Birthday%20Card.fdx
testdata/The%20Last%20Birthday%20Card.fountain
testdata/Big-Fish.fdx
testdata/Big-Fish.fountain
testdata/Brick-&-Steel.fdx
testdata/Brick-&-Steel.fountain
testdata/The-Last-Birthday-Card.fdx
testdata/The-Last-Birthday-Card.fountain
*.bak
8 changes: 5 additions & 3 deletions CITATION.cff
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@ cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "scripttool"
abstract: "A library and command line program for working with fdx (Final Draft XML), osf, Fade In and Fountain formatted Screen Play files."
abstract: "A library and command line program for working with fdx
(Final Draft XML), osf, Fade In and Fountain formatted Screen Play
files."
authors:
- family-names: Doiel
given-names: Robert
Expand All @@ -14,6 +16,6 @@ maintainers:
orcid: ""

repository-code: "https://github.com/rsdoiel/scripttool"
version: 0.0.8
license-url: "https://rsdoiel.github.io/scripttool/license.html"
version: 0.0.10
license-url: "https://spdx.org/licenses/AGPL-3.0-or-later"
keywords: [ "Github", "text markup", "screen play" ]
68 changes: 44 additions & 24 deletions INSTALL.html
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!DOCTYPE html>
<html lang="en">
<html lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="language" content="EN">
Expand All @@ -16,8 +16,8 @@
<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="user_manual.html">User Manual</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="about.html">About</a></li>
<li><a href="INSTALL.html">Install</a></li>
<li><a href="https://github.com/rsdoiel/scripttool">GitHub</a></li>
Expand All @@ -28,15 +28,24 @@
<!-- <h1>INSTALL</h1> -->

<h1 id="installation">Installation</h1>
<p><em>scripttool</em> is a command line program run from a shell like Bash. You can find compiled version in the <a href="https://github.com/rsdoiel/scripttool/releases/latest">releases</a></p>
<p><em>scripttool</em> is a command line program run from a shell like
Bash. You can find compiled version in the <a
href="https://github.com/rsdoiel/scripttool/releases/latest">releases</a></p>
<h2 id="quick-install-via-curl">Quick install via curl</h2>
<p>This project can be installed via curl and sh for POSIX compatible systems. Enter the following in your shell.</p>
<p>This project can be installed via curl and sh for POSIX compatible
systems. Enter the following in your shell.</p>
<pre><code>curl https://rsdoiel.github.io/scripttool/installer.sh | sh</code></pre>
<h2 id="compiled-version">Compiled version</h2>
<p>This is generalized instructions for a release.</p>
<p>Compiled versions are available for Mac OS (Intel and M1/M2 processor, macOS-x86_64, macOS-arm64), Linux (Intel process, linux-x86_64), Windows (Intel processor, Windows-x86_64), Rapsberry Pi OS (arm7 processor, RaspberryPiOS-arm7) and Pine64 (arm64 processor, Linux-aarch64)</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>
<p>Compiled versions are available for Mac OS (Intel and M1/M2
processor, macOS-x86_64, macOS-arm64), Linux (Intel process,
Linux-x86_64), Windows (Intel processor, Windows-x86_64), Raspberry Pi
OS (arm7 32bit processor, RaspberryPiOS-arm7) and Pine64 (arm64
processor, Linux-aarch64)</p>
<p>VERSION_NUMBER is a <a href="http://semver.org/">semantic 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/scripttool/releases/latest</p>
</blockquote>
Expand Down Expand Up @@ -65,8 +74,8 @@ <h2 id="compiled-version">Compiled version</h2>
<td>scripttool-VERSION_NUMBER-Linux-x86_64.zip</td>
</tr>
<tr class="odd">
<td>Raspbery Pi</td>
<td>scripttool-VERSION_NUMBER-RaspbianPiOS-arm7.zip</td>
<td>Raspberry Pi</td>
<td>scripttool-VERSION_NUMBER-RaspberryPiOS-arm7.zip</td>
</tr>
<tr class="even">
<td>Pine64</td>
Expand All @@ -76,31 +85,36 @@ <h2 id="compiled-version">Compiled version</h2>
</table>
<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>
<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>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
<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>
<h3 id="mac-os">Mac OS</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>Copy the executable 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 scripttool-*-macOS-x86_64.zip
mkdir -p $HOME/bin
Expand All @@ -111,10 +125,11 @@ <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>Copy the executable 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 scripttool-*-Windows-x86_64.zip
mkdir -p $HOME/bin
Expand All @@ -125,33 +140,38 @@ <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>Copy the executable 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 scripttool-*-Linux-x86_64.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h3 id="raspberry-pi-os">Raspberry Pi OS</h3>
<p>Released version is for a Raspberry Pi 3 or later use (i.e. requires ARM 7 support).</p>
<p>Released version is for a Raspberry Pi 3 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>Copy the executable 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 scripttool-*-RaspberryPiOS-arm7.zip
mkdir -p $HOME/bin
cp -v bin/* $HOME/bin/
export PATH=$HOME/bin:$PATH
scripttool -version</code></pre>
<h2 id="compiling-from-source">Compiling from source</h2>
<p><em>scripttool</em> is “go gettable”. Use the “go get” command to download the dependant packages as well as <em>scripttool</em>’s source code.</p>
<p><em>scripttool</em> is “go gettable”. Use the “go get” command to
download the dependent packages as well as <em>scripttool</em>’s source
code.</p>
<pre class="shell"><code> go get -u github.com/rsdoiel/scripttool/...</code></pre>
<p>Or clone the repository and then compile</p>
<pre class="shell"><code> cd
Expand Down
20 changes: 10 additions & 10 deletions INSTALL.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Compiled version
This is generalized instructions for a release.

Compiled versions are available for Mac OS (Intel and M1/M2 processor, macOS-x86_64, macOS-arm64),
Linux (Intel process, linux-x86_64), Windows (Intel processor, Windows-x86_64),
Rapsberry Pi OS (arm7 processor, RaspberryPiOS-arm7) and Pine64 (arm64 processor, Linux-aarch64)
Linux (Intel process, Linux-x86_64), Windows (Intel processor, Windows-x86_64),
Raspberry Pi OS (arm7 32bit processor, RaspberryPiOS-arm7) and Pine64 (arm64 processor, Linux-aarch64)

VERSION_NUMBER is a [symantic version number](http://semver.org/) (e.g. v0.1.2)
VERSION\_NUMBER is a [semantic version number](http://semver.org/) (e.g. v0.1.2)


For all the released version go to the project page on Github and click latest release
For all the released version go to the project page on GitHub and click latest release

> https://github.com/rsdoiel/scripttool/releases/latest
Expand All @@ -39,7 +39,7 @@ For all the released version go to the project page on Github and click latest r
| Mac OS (Intel) | scripttool-VERSION_NUMBER-macOS-x86_64.zip |
| Mac OS (M1,M2) | scripttool-VERSION_NUMBER-macOS-arm64.zip |
| Linux/Intel | scripttool-VERSION_NUMBER-Linux-x86_64.zip |
| Raspbery Pi | scripttool-VERSION_NUMBER-RaspbianPiOS-arm7.zip |
| Raspberry Pi | scripttool-VERSION_NUMBER-RaspberryPiOS-arm7.zip |
| Pine64 | scripttool-VERSION_NUMBER-Linux-aarch64.zip |


Expand All @@ -60,7 +60,7 @@ The basic recipe

1. Download the zip file
2. Unzip the zip file
3. Copy the executables to $HOME/bin (or a folder in your path)
3. Copy the executable to $HOME/bin (or a folder in your path)
4. Make sure the new location in in our path
5. Test

Expand All @@ -80,7 +80,7 @@ zip file.

1. Download the zip file
2. Unzip the zip file
3. Copy the executables to $HOME/bin (or a folder in your path)
3. Copy the executable to $HOME/bin (or a folder in your path)
4. Test

Here's an example of the commands run in from the Bash shell on Windows 10 after
Expand All @@ -100,7 +100,7 @@ downloading the zip file.

1. Download the zip file
2. Unzip the zip file
3. Copy the executables to $HOME/bin (or a folder in your path)
3. Copy the executable to $HOME/bin (or a folder in your path)
4. Test

Here's an example of the commands run in from the Bash shell after
Expand All @@ -122,7 +122,7 @@ Released version is for a Raspberry Pi 3 or later use (i.e. requires ARM 7 suppo

1. Download the zip file
2. Unzip the zip file
3. Copy the executables to $HOME/bin (or a folder in your path)
3. Copy the executable to $HOME/bin (or a folder in your path)
4. Test

Here's an example of the commands run in from the Bash shell after
Expand All @@ -141,7 +141,7 @@ downloading the zip file.
Compiling from source
---------------------

_scripttool_ is "go gettable". Use the "go get" command to download the dependant packages
_scripttool_ is "go gettable". Use the "go get" command to download the dependent packages
as well as _scripttool_'s source code.

```shell
Expand Down
Loading

0 comments on commit 1f4123a

Please sign in to comment.