Skip to content

Commit

Permalink
updated license to AGPL 3 or later
Browse files Browse the repository at this point in the history
  • Loading branch information
R. S. Doiel committed May 20, 2024
1 parent 494f1e1 commit da5e106
Show file tree
Hide file tree
Showing 24 changed files with 848 additions and 141 deletions.
7 changes: 4 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "fountain"
abstract: "A library and command line program for working with Fountain script/screenplay formatted files."
abstract: "A library and command line program for working with Fountain
script/screenplay formatted files."
authors:
- family-names: Doiel
given-names: Robert
Expand All @@ -14,6 +15,6 @@ maintainers:
orcid: ""

repository-code: "https://github.com/rsdoiel/fountain"
version: 1.0.1
license-url: "https://rsdoiel.github.io/fountain/license.html"
version: 1.0.2
license-url: "https://spdx.org/licenses/AGPL-3.0-or-later"
keywords: [ "GitHub", "text markup", "screen play" ]
16 changes: 11 additions & 5 deletions INSTALL.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,11 @@
<!-- <h1>INSTALL</h1> -->

<h2 id="installation">Installation</h2>
<p>This project is experimental. Get the latest release from <a href="https://github.com/rsdoiel/fountain/releases/">GitHub</a>.</p>
<p>This project is experimental. Get the latest release from <a
href="https://github.com/rsdoiel/fountain/releases/">GitHub</a>.</p>
<h2 id="quick-install-with-curl">Quick install with curl</h2>
<p>If you are using macOS or Linux you maybe able to install fountain using the following curl command.</p>
<p>If you are using macOS or Linux you maybe able to install fountain
using the following curl command.</p>
<pre class="shell"><code>curl https://rsdoiel.github.io/fountain/installer.sh | sh</code></pre>
<h2 id="install-from-source">Install from source</h2>
<h2 id="requirements">Requirements</h2>
Expand All @@ -44,17 +46,21 @@ <h2 id="steps">Steps</h2>
<ol type="1">
<li>Clone the Git repository for the project</li>
<li>change directory into the cloned project</li>
<li>Run <code>make</code>, <code>make test</code> and <code>make install</code></li>
<li>Run <code>make</code>, <code>make test</code> and
<code>make install</code></li>
</ol>
<p>Here’s what that looks like for me.</p>
<pre><code>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>
<p>By default it will install the programs in <code>$HOME/bin</code>. <code>$HOME/bin</code> needs to be included in your <code>PATH</code>. E.g.</p>
<p>By default it will install the programs in <code>$HOME/bin</code>.
<code>$HOME/bin</code> needs to be included in your <code>PATH</code>.
E.g.</p>
<pre><code>export PATH=&quot;$HOME/bin:$PATH&quot;</code></pre>
<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or <code>.zshrc</code> file depending on your system’s shell.</p>
<p>Can be added to your <code>.profile</code>, <code>.bashrc</code> or
<code>.zshrc</code> file depending on your system’s shell.</p>
</section>

<footer>
Expand Down
71 changes: 37 additions & 34 deletions TODO.html
Original file line number Diff line number Diff line change
Expand Up @@ -30,53 +30,56 @@
<h1 id="action-items">Action Items</h1>
<h2 id="bugs">Bugs</h2>
<ul class="task-list">
<li><input type="checkbox" disabled="" checked="" />
Transition follow by transition at end of script treats the second transition as action, see sample-05.fountain, noticed in HTML output<ul>
<li><label><input type="checkbox" checked="" />Transition follow by
transition at end of script treats the second transition as action, see
sample-05.fountain, noticed in HTML output</label>
<ul>
<li>A: OK, the line begins with “!” so it should be “Action”</li>
</ul></li>
<li><input type="checkbox" disabled="" />
sample-05.fountain has the character “DOG” line identified as “dialogue”</li>
<li><input type="checkbox" disabled="" />
sample-07.fountain (charade) has parenthiticals sprinkled in the dialogue, need to support this. It meakes some dialog show up as Action in the JSON stream.</li>
<li><label><input type="checkbox" />sample-05.fountain has the character
“DOG” line identified as “dialogue”</label></li>
<li><label><input type="checkbox" />sample-07.fountain (charade) has
parenthiticals sprinkled in the dialogue, need to support this. It
meakes some dialog show up as Action in the JSON stream.</label></li>
</ul>
<h2 id="next-v0.1.0">Next (v0.1.0)</h2>
<ul class="task-list">
<li><input type="checkbox" disabled="" />
Add test to check to validate parse structure of each <code>testdata/*.fountain</code> file</li>
<li><input type="checkbox" disabled="" />
Add demo of using <strong>fountain2json</strong> for creating a script report</li>
<li><input type="checkbox" disabled="" />
Improve <strong>fountainfmt</strong> pretty print options</li>
<li><input type="checkbox" disabled="" />
handle unlabeled title pages</li>
<li><input type="checkbox" disabled="" checked="" />
Write and <strong>fountain2html</strong></li>
<li><input type="checkbox" disabled="" />
Add CSS dump option for <strong>fountain2html</strong></li>
<li><input type="checkbox" disabled="" />
Add option to render <a href="https://fountain.io/scrippets">scrippets</a> compatible HTML and CSS</li>
<li><label><input type="checkbox" />Add test to check to validate parse
structure of each <code>testdata/*.fountain</code> file</label></li>
<li><label><input type="checkbox" />Add demo of using
<strong>fountain2json</strong> for creating a script report</label></li>
<li><label><input type="checkbox" />Improve <strong>fountainfmt</strong>
pretty print options</label></li>
<li><label><input type="checkbox" />handle unlabeled title
pages</label></li>
<li><label><input type="checkbox" checked="" />Write and
<strong>fountain2html</strong></label></li>
<li><label><input type="checkbox" />Add CSS dump option for
<strong>fountain2html</strong></label></li>
<li><label><input type="checkbox" />Add option to render <a
href="https://fountain.io/scrippets">scrippets</a> compatible HTML and
CSS</label></li>
</ul>
<h2 id="someday-maybe">Someday, Maybe</h2>
<ul class="task-list">
<li><input type="checkbox" disabled="" />
Add support for Markdown front matter for additiona metadata processing</li>
<li><input type="checkbox" disabled="" />
handle general text (outside of notes, boneyard)<ul>
<li><label><input type="checkbox" />Add support for Markdown front
matter for additiona metadata processing</label></li>
<li><label><input type="checkbox" />handle general text (outside of
notes, boneyard)</label>
<ul>
<li>this could be handled like front matter in Markdown</li>
</ul></li>
<li><input type="checkbox" disabled="" />
definable heading prefixes</li>
<li><input type="checkbox" disabled="" />
reports on screenplay</li>
<li><input type="checkbox" disabled="" />
fountain2pdf</li>
<li><label><input type="checkbox" />definable heading
prefixes</label></li>
<li><label><input type="checkbox" />reports on screenplay</label></li>
<li><label><input type="checkbox" />fountain2pdf</label></li>
</ul>
<h2 id="completed">Completed</h2>
<ul class="task-list">
<li><input type="checkbox" disabled="" checked="" />
Write Parse(src []byte) returning a Fountain Struct and error</li>
<li><input type="checkbox" disabled="" checked="" />
word wrap for dialogue</li>
<li><label><input type="checkbox" checked="" />Write Parse(src []byte)
returning a Fountain Struct and error</label></li>
<li><label><input type="checkbox" checked="" />word wrap for
dialogue</label></li>
</ul>
</section>

Expand Down
14 changes: 9 additions & 5 deletions about.html
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
<!-- <h1>about</h1> -->

<h1 id="about-this-software">About this software</h1>
<h2 id="fountain-1.0.1">fountain 1.0.1</h2>
<h2 id="fountain-1.0.2">fountain 1.0.2</h2>
<h3 id="authors">Authors</h3>
<ul>
<li>Robert Doiel</li>
Expand All @@ -37,11 +37,15 @@ <h3 id="maintainers">Maintainers</h3>
<ul>
<li></li>
</ul>
<p>A library and command line program for working with Fountain script/screenplay formatted files.</p>
<p>A library and command line program for working with Fountain
script/screenplay formatted files.</p>
<ul>
<li>License: <a href="https://rsdoiel.github.io/fountain/license.html" class="uri">https://rsdoiel.github.io/fountain/license.html</a></li>
<li>GitHub: <a href="https://github.com/rsdoiel/fountain" class="uri">https://github.com/rsdoiel/fountain</a></li>
<li>Issues: <a href="https://github.com/rsdoiel/fountain/issues" class="uri">https://github.com/rsdoiel/fountain/issues</a></li>
<li>License: <a href="https://spdx.org/licenses/AGPL-3.0-or-later"
class="uri">https://spdx.org/licenses/AGPL-3.0-or-later</a></li>
<li>GitHub: <a href="https://github.com/rsdoiel/fountain"
class="uri">https://github.com/rsdoiel/fountain</a></li>
<li>Issues: <a href="https://github.com/rsdoiel/fountain/issues"
class="uri">https://github.com/rsdoiel/fountain/issues</a></li>
</ul>
<h3 id="programming-languages">Programming languages</h3>
<ul>
Expand Down
14 changes: 8 additions & 6 deletions about.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,24 @@ cff-version: 1.2.0
message: "If you use this software, please cite it as below."
type: software
title: "fountain"
abstract: "A library and command line program for working with Fountain script/screenplay formatted files."
abstract: "A library and command line program for working with Fountain
script/screenplay formatted files."
authors:
- family-names: Doiel
given-names: Robert
orcid: "https://orcid.org/0000-0003-0900-6903"

repository-code: "https://github.com/rsdoiel/fountain"
version: 1.0.1
license-url: "https://rsdoiel.github.io/fountain/license.html"
version: 1.0.2
license-url: "https://spdx.org/licenses/AGPL-3.0-or-later"
keywords: [ "GitHub", "text markup", "screen play" ]

---

About this software
===================

## fountain 1.0.1
## fountain 1.0.2

### Authors

Expand All @@ -30,9 +31,10 @@ About this software

-

A library and command line program for working with Fountain script/screenplay formatted files.
A library and command line program for working with Fountain
script/screenplay formatted files.

- License: <https://rsdoiel.github.io/fountain/license.html>
- License: <https://spdx.org/licenses/AGPL-3.0-or-later>
- GitHub: <https://github.com/rsdoiel/fountain>
- Issues: <https://github.com/rsdoiel/fountain/issues>

Expand Down
39 changes: 26 additions & 13 deletions fountain2html.1.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,45 +32,58 @@ <h1 id="name">NAME</h1>
<h1 id="synopsis">SYNOPSIS</h1>
<p>fountain2html <a href="#options">OPTIONS</a></p>
<h1 id="description">DESCRIPTION</h1>
<p>fountain2html is a command line program that reads an fountain document and writes out HTML.</p>
<p>fountain2html is a command line program that reads an fountain
document and writes out HTML.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>display help
<dd>
display help
</dd>
<dt>-license</dt>
<dd>display license
<dd>
display license
</dd>
<dt>-version</dt>
<dd>display version
<dd>
display version
</dd>
<dt>-i</dt>
<dd>read from input file
<dd>
read from input file
</dd>
<dt>-o</dt>
<dd>read from output file
<dd>
read from output file
</dd>
<dt>-newline</dt>
<dd>add a trailing newline
<dd>
add a trailing newline
</dd>
<dt>-page</dt>
<dd>If true output an HTML page otherwise an HTML fragement
<dd>
If true output an HTML page otherwise an HTML fragement
</dd>
<dt>-inline-css</dt>
<dd>Add inline CSS
<dd>
Add inline CSS
</dd>
<dt>-link-css</dt>
<dd>Add a link to CSS (default CSS is fountain.css)
<dd>
Add a link to CSS (default CSS is fountain.css)
</dd>
<dt>-css</dt>
<dd>Include a custom CSS file
<dd>
Include a custom CSS file
</dd>
<dt>-width</dt>
<dd>set the width for the text
<dd>
set the width for the text
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Convert a <em>screenplay.fountain</em> to <em>screenplay.html</em>.</p>
<p>Convert a <em>screenplay.fountain</em> to
<em>screenplay.html</em>.</p>
<pre><code> fountain2html -i screenplay.foutnain -o screenplay.html</code></pre>
<p>Or alternatively</p>
<pre><code> cat screenplay.fountain | fountain2html &gt;screenplay.html</code></pre>
Expand Down
4 changes: 2 additions & 2 deletions fountain2html.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%fountain2html(1) | version 1.0.1 c963739
%fountain2html(1) | version 1.0.2 494f1e1
% R. S. Doiel
% 2024-03-09
% 2024-05-20

# NAME

Expand Down
27 changes: 18 additions & 9 deletions fountain2json.1.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,32 +32,41 @@ <h1 id="name">NAME</h1>
<h1 id="synopsis">SYNOPSIS</h1>
<p>fountain2json <a href="#options">OPTIONS</a></p>
<h1 id="description">DESCRIPTION</h1>
<p>fountain2json is a command line program that reads an fountain document and returns a JSON representation of it.</p>
<p>fountain2json is a command line program that reads an fountain
document and returns a JSON representation of it.</p>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>display help
<dd>
display help
</dd>
<dt>-license</dt>
<dd>display license
<dd>
display license
</dd>
<dt>-version</dt>
<dd>display version
<dd>
display version
</dd>
<dt>-i</dt>
<dd>read from filename
<dd>
read from filename
</dd>
<dt>-o</dt>
<dd>write to filename
<dd>
write to filename
</dd>
<dt>-newline</dt>
<dd>add a trailing newline
<dd>
add a trailing newline
</dd>
<dt>-width</dt>
<dd>set the width of the text
<dd>
set the width of the text
</dd>
<dt>-pretty</dt>
<dd>pretty print the output
<dd>
pretty print the output
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
Expand Down
4 changes: 2 additions & 2 deletions fountain2json.1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
%fountain2json(1) | version 1.0.1 c963739
%fountain2json(1) | version 1.0.2 494f1e1
% R. S. Doiel
% 2024-03-09
% 2024-05-20

# NAME

Expand Down
Loading

0 comments on commit da5e106

Please sign in to comment.