diff --git a/install.html b/install.html index facf304..9f7c346 100644 --- a/install.html +++ b/install.html @@ -1,257 +1,156 @@ - + - fountain, a Go package for working with Fountain screenplay format - + + + R. S. Doiel, Software Engineer/Analyst - INSTALL + + + + + + -
-fountain, a Go package for working with Fountain screenplay format -
+ +
-

-Installation -

-

-fountain2json, fountainfmt, fountain2html are a command line programs run from a shell like Bash. You can find compiled version in the releases -

-

-Compiled version -

-

-This is generalized instructions for a release. -

-

-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) -

-

-VERSION_NUMBER is a symantic version number (e.g. v0.1.2) -

-

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

+ + +

{ “title”: “fountain, a Go package for working with Fountain screenplay format” }

+

Installation

+

fountain2json, fountainfmt, fountain2html are a command line programs run from a shell like Bash. You can find compiled version in the releases

+

Compiled version

+

This is generalized instructions for a release.

+

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)

+

VERSION_NUMBER is a symantic version number (e.g. v0.1.2)

+

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

-

-https://github.com/rsdoiel/fountain/releases/latest -

+

https://github.com/rsdoiel/fountain/releases/latest

- - + + - - + + - - + + - - + + - - + + - - + + - - + +
-Platform - -Zip Filename -PlatformZip Filename
-Windows - -fountain-VERSION_NUMBER-windows-amd64.zip -Windowsfountain-VERSION_NUMBER-windows-amd64.zip
-Mac OS X - -fountain-VERSION_NUMBER-macos-amd64.zip -Mac OS Xfountain-VERSION_NUMBER-macos-amd64.zip
-Mac OS X - -fountain-VERSION_NUMBER-macos-arm64.zip -Mac OS Xfountain-VERSION_NUMBER-macos-arm64.zip
-Linux/Intel - -fountain-VERSION_NUMBER-linux-amd64.zip -Linux/Intelfountain-VERSION_NUMBER-linux-amd64.zip
-Raspbery Pi - -fountain-VERSION_NUMBER-raspbian-arm7.zip -Raspbery Pifountain-VERSION_NUMBER-raspbian-arm7.zip
-Pine64 - -fountain-VERSION_NUMBER-linux-arm64.zip -Pine64fountain-VERSION_NUMBER-linux-arm64.zip
-

-The basic recipe -

+

The basic recipe

+
  • Download the zip file and unzip the file.
    • -
  • -Download the zip file and unzip the file.
    -
    • -
  • -Copy the contents of the folder named “bin” to a folder that is in your path +
  • Copy the contents of the folder named “bin” to a folder that is in your path -
    • -
  • -Adjust your PATH if needed +
  • (e.g. “$HOME/bin” is common).
    • + +
  • Adjust your PATH if needed
    • +
  • Test
    • - -
  • -Test -
    • - -

    -Mac OS X -

    +

    Mac OS X

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

    -Here’s an example of the commands run in the Terminal App after downloading the zip file. -

    +

    Here’s an example of the commands run in the Terminal App after downloading the zip file.

        cd Downloads/
     unzip fountain-*-macos-amd64.zip
     mkdir -p $HOME/bin
     cp -v bin/* $HOME/bin/
     export PATH=$HOME/bin:$PATH
     fountain -version
    -

    -Windows -

    +

    Windows

      -
    1. -Download the zip file -
      2. -
    2. -Unzip the zip file -
      3. -
    3. -Copy the executables to $HOME/bin (or a folder in your path) -
      4. -
    4. -Test -
      5. +
    5. Download the zip file
      6. +
    6. Unzip the zip file
      7. +
    7. Copy the executables to $HOME/bin (or a folder in your path)
      8. +
    8. Test
    -

    -Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file. -

    +

    Here’s an example of the commands run in from the Bash shell on Windows 10 after downloading the zip file.

        cd Downloads/
     unzip fountain-*-windows-amd64.zip
     mkdir -p $HOME/bin
     cp -v bin/* $HOME/bin/
     export PATH=$HOME/bin:$PATH
     fountain -version
    -

    -Linux -

    +

    Linux

      -
    1. -Download the zip file -
      2. -
    2. -Unzip the zip file -
      3. -
    3. -Copy the executables to $HOME/bin (or a folder in your path) -
      4. -
    4. -Test -
      5. +
    5. Download the zip file
      6. +
    6. Unzip the zip file
      7. +
    7. Copy the executables to $HOME/bin (or a folder in your path)
      8. +
    8. Test
    -

    -Here’s an example of the commands run in from the Bash shell after downloading the zip file. -

    +

    Here’s an example of the commands run in from the Bash shell after downloading the zip file.

        cd Downloads/
     unzip fountain-*-linux-amd64.zip
     mkdir -p $HOME/bin
     cp -v bin/* $HOME/bin/
     export PATH=$HOME/bin:$PATH
     fountain -version
    -

    -Raspberry Pi -

    -

    -Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support). -

    +

    Raspberry Pi

    +

    Released version is for a Raspberry Pi 2 or later use (i.e. requires ARM 7 support).

      -
    1. -Download the zip file -
      2. -
    2. -Unzip the zip file -
      3. -
    3. -Copy the executables to $HOME/bin (or a folder in your path) -
      4. -
    4. -Test -
      5. +
    5. Download the zip file
      6. +
    6. Unzip the zip file
      7. +
    7. Copy the executables to $HOME/bin (or a folder in your path)
      8. +
    8. Test
    -

    -Here’s an example of the commands run in from the Bash shell after downloading the zip file. -

    +

    Here’s an example of the commands run in from the Bash shell after downloading the zip file.

        cd Downloads/
     unzip fountain-*-raspbian-arm7.zip
     mkdir -p $HOME/bin
     cp -v bin/* $HOME/bin/
     export PATH=$HOME/bin:$PATH
     fountain -version
    -

    -Compiling from source -

    -

    -The fountain command line programs are “go gettable”. Use the “go get” command to download the dependant packages as well as source code. -

    +

    Compiling from source

    +

    The fountain command line programs are “go gettable”. Use the “go get” command to download the dependant packages as well as source code.

        go get -u github.com/rsdoiel/fountain/...
    -

    -Or clone the repstory and then compile -

    +

    Or clone the repstory and then compile

        cd
     git clone https://github.com/rsdoiel/fountain src/github.com/rsdoiel/fountain
     cd src/github.com/rsdoiel/fountain
@@ -259,35 +158,9 @@ 
    
     make test
     make install
    - + +