Skip to content

Commit a8dd639

Browse files
rsdoielrsdoiel
committed
Merge branch 'main' of github.com:rsdoiel/scripttools into gh-pages
2 parents d5ca4cf + ea8ed24 commit a8dd639

111 files changed

Lines changed: 1096 additions & 1229 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎CITATION.cff‎

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1+
12
cff-version: 1.2.0
23
message: "If you use this software, please cite it as below."
34
type: software
4-
title: "scripttool"
5-
abstract: "A library and command line program for working with fdx
6-
(Final Draft XML), osf, Fade In and Fountain formatted Screen Play
7-
files."
5+
title: scripttool
6+
abstract: "A library and command line program for working with fdx (Final Draft XML), osf, Fade In and Fountain formatted Screen Play files."
87
authors:
98
- family-names: Doiel
109
given-names: Robert
11-
orcid: "https://orcid.org/0000-0003-0900-6903"
10+
orcid: https://orcid.org/0000-0003-0900-6903
11+
email: rsdoiel@gmail.com
1212

13-
maintainers:
13+
contacts:
1414
- family-names:
1515
given-names:
16-
orcid: ""
1716

1817
repository-code: "https://github.com/rsdoiel/scripttool"
1918
version: 0.0.10
19+
20+
2021
license-url: "https://spdx.org/licenses/AGPL-3.0-or-later"
21-
keywords: [ "Github", "text markup", "screen play" ]
22+
keywords:
23+
- Github
24+
- text markup
25+
- screen play
26+

‎INSTALL.html‎

Lines changed: 47 additions & 175 deletions
Original file line numberDiff line numberDiff line change
@@ -1,192 +1,64 @@
11
<!DOCTYPE html>
22
<html lang="en-US">
33
<head>
4-
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
5-
<meta name="language" content="EN">
6-
<title>R. S. Doiel, Software Engineer/Analyst - INSTALL</title>
7-
8-
<link rel="stylesheet" type="text/css" href="/printfonts/print.css" media="print" />
9-
<link rel="stylesheet" type="text/css" href="/webfonts/fonts.css" media="screen" />
10-
<link rel="stylesheet" type="text/css" href="/css/site.css" media="screen" />
11-
<link title="RSS feed for rsdoiel's blog" rel="alternate" type="application/rss+xml" href="https://rsdoiel.github.io/rss.xml" />
12-
<link title="markdown source for page" rel="alternative" type="application/markdown" href="INSTALL.md">
4+
<title>scripttools</title>
5+
<link rel="stylesheet" href="/css/site.css">
136
</head>
147
<body>
158
<nav>
169
<ul>
17-
<li><a href="/">Home</a></li>
18-
<li><a href="./">README</a></li>
19-
<li><a href="user_manual.html">User Manual</a></li>
20-
<li><a href="LICENSE">LICENSE</a></li>
21-
<li><a href="about.html">About</a></li>
22-
<li><a href="INSTALL.html">Install</a></li>
23-
<li><a href="https://github.com/rsdoiel/scripttool">GitHub</a></li>
10+
<li><a href="/">Home</a></li>
11+
<li><a href="index.html">README</a></li>
12+
<li><a href="LICENSE">LICENSE</a></li>
13+
<li><a href="INSTALL.html">INSTALL</a></li>
14+
<li><a href="user_manual.html">User Manual</a></li>
15+
<li><a href="about.html">About</a></li>
16+
<li><a href="search.html">Search</a></li>
17+
<li><a href="https://github.com/rsdoiel/scripttool">GitHub</a></li>
2418
</ul>
2519
</nav>
26-
2720
<section>
28-
<!-- <h1>INSTALL</h1> -->
29-
30-
<h1 id="installation">Installation</h1>
31-
<p><em>scripttool</em> is a command line program run from a shell like
32-
Bash. You can find compiled version in the <a
33-
href="https://github.com/rsdoiel/scripttool/releases/latest">releases</a></p>
34-
<h2 id="quick-install-via-curl-or-irm">Quick install via curl or
21+
<h1 id="installation-for-development-of-scripttool">Installation for
22+
development of <strong>scripttool</strong></h1>
23+
<p><strong>scripttool</strong> A library and command line program for
24+
working with fdx (Final Draft XML), osf, Fade In and Fountain formatted
25+
Screen Play files.</p>
26+
<h2 id="quick-install-with-curl-or-irm">Quick install with curl or
3527
irm</h2>
36-
<p>This project can be installed via curl and sh for POSIX compatible
37-
systems. Enter the following in your shell.</p>
38-
<pre><code>curl https://rsdoiel.github.io/scripttool/installer.sh | sh</code></pre>
39-
<p>On Windows use the following Powershell command.</p>
40-
<pre><code>irm https://rsdoiel.github.io/scripttool/installer.ps1 | iex</code></pre>
41-
<h2 id="compiled-version">Compiled version</h2>
42-
<p>This is generalized instructions for a release.</p>
43-
<p>Compiled versions are available for Mac OS (Intel and M1/M2
44-
processor, macOS-x86_64, macOS-arm64), Linux (Intel process,
45-
Linux-x86_64), Windows (Intel processor, Windows-x86_64), Raspberry Pi
46-
OS (arm7 32bit processor, RaspberryPiOS-arm7) and Pine64 (arm64
47-
processor, Linux-aarch64)</p>
48-
<p>VERSION_NUMBER is a <a href="http://semver.org/">semantic version
49-
number</a> (e.g. v0.1.2)</p>
50-
<p>For all the released version go to the project page on GitHub and
51-
click latest release</p>
52-
<blockquote>
53-
<p>https://github.com/rsdoiel/scripttool/releases/latest</p>
54-
</blockquote>
55-
<table>
56-
<thead>
57-
<tr>
58-
<th>Platform</th>
59-
<th>Zip Filename</th>
60-
</tr>
61-
</thead>
62-
<tbody>
63-
<tr>
64-
<td>Windows</td>
65-
<td>scripttool-VERSION_NUMBER-Windows-x86_64.zip</td>
66-
</tr>
67-
<tr>
68-
<td>Mac OS (Intel)</td>
69-
<td>scripttool-VERSION_NUMBER-macOS-x86_64.zip</td>
70-
</tr>
71-
<tr>
72-
<td>Mac OS (M1,M2)</td>
73-
<td>scripttool-VERSION_NUMBER-macOS-arm64.zip</td>
74-
</tr>
75-
<tr>
76-
<td>Linux/Intel</td>
77-
<td>scripttool-VERSION_NUMBER-Linux-x86_64.zip</td>
78-
</tr>
79-
<tr>
80-
<td>Raspberry Pi</td>
81-
<td>scripttool-VERSION_NUMBER-RaspberryPiOS-arm7.zip</td>
82-
</tr>
83-
<tr>
84-
<td>Pine64</td>
85-
<td>scripttool-VERSION_NUMBER-Linux-aarch64.zip</td>
86-
</tr>
87-
</tbody>
88-
</table>
89-
<h2 id="the-basic-recipe">The basic recipe</h2>
28+
<p>There is an experimental installer.sh script that can be run with the
29+
following command to install latest table release. This may work for
30+
macOS, Linux and if you’re using Windows with the Unix subsystem. This
31+
would be run from your shell (e.g. Terminal on macOS).</p>
32+
<pre class="shell"><code>curl https://rsdoiel.github.io/scripttool/installer.sh | sh</code></pre>
33+
<p>This will install the programs included in scripttool in your
34+
<code>$HOME/bin</code> directory.</p>
35+
<p>If you are running Windows 10 or 11 use the Powershell command
36+
below.</p>
37+
<div class="sourceCode" id="cb2"><pre
38+
class="sourceCode ps1"><code class="sourceCode powershell"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">irm</span> https<span class="op">://</span>rsdoiel<span class="op">.</span><span class="fu">github</span><span class="op">.</span><span class="fu">io</span><span class="op">/</span>scripttool<span class="op">/</span>installer<span class="op">.</span><span class="fu">ps1</span> <span class="op">|</span> <span class="fu">iex</span></span></code></pre></div>
39+
<h3 id="if-your-are-running-macos-or-windows">If your are running macOS
40+
or Windows</h3>
41+
<p>You may get security warnings if you are using macOS or Windows. See
42+
the notes for the specific operating system you’re using to fix
43+
issues.</p>
9044
<ul>
91-
<li>Find the Zip file listed matching the architecture you’re running
92-
and download it
93-
<ul>
94-
<li>(e.g. if you’re on a Windows 10 laptop/Surface with a amd64 style
95-
CPU you’d choose the Zip file with “windows-amd64” in the name).</li>
96-
</ul></li>
97-
<li>Download the zip file and unzip the file.<br />
98-
</li>
99-
<li>Copy the contents of the folder named “bin” to a folder that is in
100-
your path
101-
<ul>
102-
<li>(e.g. “$HOME/bin” is common).</li>
103-
</ul></li>
104-
<li>Adjust your PATH if needed
105-
<ul>
106-
<li>(e.g. export PATH=“<span
107-
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>
108-
</ul></li>
109-
<li>Test</li>
45+
<li><a href="INSTALL_NOTES_macOS.html">INSTALL_NOTES_macOS.md</a></li>
46+
<li><a
47+
href="INSTALL_NOTES_Windows.html">INSTALL_NOTES_Windows.md</a></li>
11048
</ul>
111-
<h3 id="mac-os">Mac OS</h3>
112-
<ol type="1">
113-
<li>Download the zip file</li>
114-
<li>Unzip the zip file</li>
115-
<li>Copy the executable to $HOME/bin (or a folder in your path)</li>
116-
<li>Make sure the new location in in our path</li>
117-
<li>Test</li>
118-
</ol>
119-
<p>Here’s an example of the commands run in the Terminal App after
120-
downloading the zip file.</p>
121-
<pre class="shell"><code> cd Downloads/
122-
unzip scripttool-*-macOS-x86_64.zip
123-
mkdir -p $HOME/bin
124-
cp -v bin/* $HOME/bin/
125-
export PATH=$HOME/bin:$PATH
126-
scripttool -version</code></pre>
127-
<h3 id="windows">Windows</h3>
128-
<ol type="1">
129-
<li>Download the zip file</li>
130-
<li>Unzip the zip file</li>
131-
<li>Copy the executable to $HOME/bin (or a folder in your path)</li>
132-
<li>Test</li>
133-
</ol>
134-
<p>Here’s an example of the commands run in from the Bash shell on
135-
Windows 10 after downloading the zip file.</p>
136-
<pre class="shell"><code> cd Downloads/
137-
unzip scripttool-*-Windows-x86_64.zip
138-
mkdir -p $HOME/bin
139-
cp -v bin/* $HOME/bin/
140-
export PATH=$HOME/bin:$PATH
141-
scripttool -version</code></pre>
142-
<h3 id="linux">Linux</h3>
143-
<ol type="1">
144-
<li>Download the zip file</li>
145-
<li>Unzip the zip file</li>
146-
<li>Copy the executable to $HOME/bin (or a folder in your path)</li>
147-
<li>Test</li>
148-
</ol>
149-
<p>Here’s an example of the commands run in from the Bash shell after
150-
downloading the zip file.</p>
151-
<pre class="shell"><code> cd Downloads/
152-
unzip scripttool-*-Linux-x86_64.zip
153-
mkdir -p $HOME/bin
154-
cp -v bin/* $HOME/bin/
155-
export PATH=$HOME/bin:$PATH
156-
scripttool -version</code></pre>
157-
<h3 id="raspberry-pi-os">Raspberry Pi OS</h3>
158-
<p>Released version is for a Raspberry Pi 3 or later use (i.e. requires
159-
ARM 7 support).</p>
49+
<h2 id="installing-from-source">Installing from source</h2>
50+
<h3 id="required-software">Required software</h3>
51+
<h3 id="steps">Steps</h3>
16052
<ol type="1">
161-
<li>Download the zip file</li>
162-
<li>Unzip the zip file</li>
163-
<li>Copy the executable to $HOME/bin (or a folder in your path)</li>
164-
<li>Test</li>
53+
<li>git clone https://github.com/rsdoiel/scripttool</li>
54+
<li>Change directory into the <code>scripttool</code> directory</li>
55+
<li>Make to build, test and install</li>
16556
</ol>
166-
<p>Here’s an example of the commands run in from the Bash shell after
167-
downloading the zip file.</p>
168-
<pre class="shell"><code> cd Downloads/
169-
unzip scripttool-*-RaspberryPiOS-arm7.zip
170-
mkdir -p $HOME/bin
171-
cp -v bin/* $HOME/bin/
172-
export PATH=$HOME/bin:$PATH
173-
scripttool -version</code></pre>
174-
<h2 id="compiling-from-source">Compiling from source</h2>
175-
<p><em>scripttool</em> is “go gettable”. Use the “go get” command to
176-
download the dependent packages as well as <em>scripttool</em>’s source
177-
code.</p>
178-
<pre class="shell"><code> go get -u github.com/rsdoiel/scripttool/...</code></pre>
179-
<p>Or clone the repository and then compile</p>
180-
<pre class="shell"><code> cd
181-
git clone https://github.com/rsdoiel/scripttool src/github.com/rsdoiel/scripttool
182-
cd src/github.com/rsdoiel/scripttool
183-
make
184-
make test
185-
make install</code></pre>
57+
<pre class="shell"><code>git clone https://github.com/rsdoiel/scripttool
58+
cd scripttool
59+
make
60+
make test
61+
make install</code></pre>
18662
</section>
187-
188-
<footer>
189-
</footer>
190-
19163
</body>
192-
</html>
64+
</html>

0 commit comments

Comments
 (0)