Skip to content

Commit

Permalink
v1.1.0
Browse files Browse the repository at this point in the history
closes #1
  • Loading branch information
ChapelR committed Jan 3, 2019
1 parent 5fa1211 commit 7ec9b9b
Show file tree
Hide file tree
Showing 8 changed files with 45 additions and 18 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@

An Inno Setup script and binary that installs Tweego for you, along with all current, full release built-in story formats, sets up all the environment variables, and lets you get on with your day.

Currently only available for 64-bit versions of Windows, but a 32-bit version will come someday.

## Installing Tweego

Download the binary from the releases page and run it. You'll be asked if you want to add Tweego to your PATH; leave this checked. (If you want to add Tweego to your path manuallly why are you here?)

To install additional story formats, navigate to `C:\Program Files (x86)\Tweego\story-formats\`. Create a folder here with a name corresponding to what you want to call the format, e.g. `chapbook` or `paloma`. Then download the `format.js` file from the web and place it here.
To install additional story formats, navigate to `Program Files\Tweego\story-formats\`. Create a folder here with a name corresponding to what you want to call the format, e.g. `chapbook` or `paloma`. Then download the `format.js` file from the web and place it here.

## Using Tweego

Expand All @@ -22,4 +20,4 @@ There's also a million other ways to do it, including using your IDE, using the

## Uninstalling

In the `C:\Program Files (x86)\Tweego\` directory, there should be a file named `unins000.exe`. Run this program to remove Tweego. Changes to your path variables should revert.
In the `Program Files\Tweego\` directory, there should be a file named `unins000.exe`. Run this program to remove Tweego. Changes to your path variables should revert.
1 change: 0 additions & 1 deletion pack/After.txt

This file was deleted.

3 changes: 1 addition & 2 deletions pack/LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

tweego is licensed under this Simplified BSD License.
Tweego is licensed under this Simplified BSD License.

Copyright (c) 2014-2018 Thomas Michael Edwards <[email protected]>.
All rights reserved.
Expand Down
5 changes: 2 additions & 3 deletions pack/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -1057,14 +1057,13 @@
.codehilite .gc{color:#999;background-color:#EAF2F5}
</style><title>README</title></head><body><article class="markdown-body"><h1 id="tweego-installer-for-windows">Tweego Installer for Windows<a class="headerlink" href="#tweego-installer-for-windows" title="Permanent link"></a></h1>
<p>An Inno Setup script and binary that installs Tweego for you, along with all current, full release built-in story formats, sets up all the environment variables, and lets you get on with your day.</p>
<p>Currently only available for 64-bit versions of Windows, but a 32-bit version will come someday.</p>
<h2 id="installing-tweego">Installing Tweego<a class="headerlink" href="#installing-tweego" title="Permanent link"></a></h2>
<p>Download the binary from the releases page and run it. You&rsquo;ll be asked if you want to add Tweego to your PATH; leave this checked. (If you want to add Tweego to your path manuallly why are you here?)</p>
<p>To install additional story formats, navigate to <code>C:\Program Files (x86)\Tweego\story-formats\</code>. Create a folder here with a name corresponding to what you want to call the format, e.g. <code>chapbook</code> or <code>paloma</code>. Then download the <code>format.js</code> file from the web and place it here.</p>
<p>To install additional story formats, navigate to <code>Program Files\Tweego\story-formats\</code>. Create a folder here with a name corresponding to what you want to call the format, e.g. <code>chapbook</code> or <code>paloma</code>. Then download the <code>format.js</code> file from the web and place it here.</p>
<h2 id="using-tweego">Using Tweego<a class="headerlink" href="#using-tweego" title="Permanent link"></a></h2>
<p>This is simply an installer for Tweego, it does not add anything else to it. To use Tweego, you&rsquo;ll need to run it from the command line. Refer to its docs here: <a href="http://www.motoslave.net/tweego/docs/">http://www.motoslave.net/tweego/docs/</a></p>
<p>The easiest way to get started is to create a folder, say <code>my-twine-project</code>. Open this folder, then create another one called, say, <code>src</code>. Put all your source code files (twee, js, css, html, etc) in here, then, while in the <code>my-twine-project</code> folder, press <code>Alt+D</code> type in <code>cmd</code> and press enter. In the command window, type <code>tweego -f [format] -o index.html src</code>, replacing <code>[format]</code> with the format you want to use (<code>tweego --list-formats</code> to view your installed options). This will compile everything in <code>src</code> to a file named <code>index.html</code>.</p>
<p>You can place the above command in a text file, then save it and change its <code>.txt</code> extension to <code>.bat</code> if you want. This will allow you to run the command by double-clicking on the file.</p>
<p>There&rsquo;s also a million other ways to do it, including using your IDE, using the watch options, using Node or other build tools, and a bunch of other options for compiling. This is just a basic explanation to get you started.</p>
<h2 id="uninstalling">Uninstalling<a class="headerlink" href="#uninstalling" title="Permanent link"></a></h2>
<p>In the <code>C:\Program Files (x86)\Tweego\</code> directory, there should be a file named <code>unins000.exe</code>. Run this program to remove Tweego. Changes to your path variables should revert.</p></article></body></html>
<p>In the <code>Program Files\Tweego\</code> directory, there should be a file named <code>unins000.exe</code>. Run this program to remove Tweego. Changes to your path variables should revert.</p></article></body></html>
File renamed without changes.
Binary file added pack/tweego-x86.exe
Binary file not shown.
48 changes: 40 additions & 8 deletions src/main.iss
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
; SEE THE DOCUMENTATION FOR DETAILS ON CREATING INNO SETUP SCRIPT FILES!

#define MyAppName "TweegoInstaller"
#define MyAppVersion "1.0.0"
#define MyAppVersion "1.1.0"

[Setup]
; NOTE: The value of AppId uniquely identifies this application.
Expand All @@ -12,20 +12,20 @@ AppId={{29682D59-9F14-4D71-BA16-B79BFBA9E4B8}
AppName={#MyAppName}
AppVersion={#MyAppVersion}
;AppVerName={#MyAppName} {#MyAppVersion}
DefaultDirName={pf}\{#MyAppName}
DefaultGroupName={#MyAppName}
DefaultDirName={pf}\Tweego
DefaultGroupName=Tweego
DisableProgramGroupPage=yes
LicenseFile=..\pack\LICENSE.txt
InfoBeforeFile=..\pack\Setup.txt
InfoAfterFile=..\pack\After.txt
InfoBeforeFile=setup.txt
OutputDir=..\bin
OutputBaseFilename=tweego-setup
Compression=lzma
SolidCompression=yes
ChangesEnvironment=true
ArchitecturesInstallIn64BitMode=x64

[Tasks]
Name: modifypath; Description: Add Tweego to the PATH environment variable (recommended).
Name: modifypath; Description: Add Tweego to PATH (recommended).

[Code]
const
Expand All @@ -46,7 +46,39 @@ Root: HKCU; Subkey: "Environment"; ValueType:string; ValueName: "TWEEGO_PATH"; \
[Languages]
Name: "english"; MessagesFile: "compiler:Default.isl"

[Types]
Name: "full"; Description: "Full installation"
Name: "compact"; Description: "No story formats included"
Name: "custom"; Description: "Custom installation"; Flags: iscustom

[Components]
Name: "main"; Description: "Program Files"; Types: full compact custom; Flags: fixed
Name: "readme"; Description: "Help File"; Types: full compact
Name: "formats"; Description: "Story Formats"; Types: full
Name: "formats\harlowe1"; Description: "Harlowe v1.x"; Types: full
Name: "formats\harlowe2"; Description: "Harlowe v2.x"; Types: full
Name: "formats\harlowe3"; Description: "Harlowe v3.x"; Types: full
Name: "formats\sugarcube1"; Description: "SugarCube v1.x"; Types: full
Name: "formats\sugarcube2"; Description: "SugarCube v2.x"; Types: full
Name: "formats\snowman1"; Description: "Snowman v1.x"; Types: full
Name: "formats\paperthin1"; Description: "Paperthin v1.x"; Types: full

[Dirs]
Name: "{app}\story-formats"; Permissions: users-modify

[Files]
Source: "..\pack\*"; DestDir: "{app}"; Flags: ignoreversion recursesubdirs createallsubdirs
; NOTE: Don't use "Flags: ignoreversion" on any shared system files
Source: "..\pack\tweego-x64.exe"; DestDir: "{app}"; DestName: "tweego.exe"; Check: Is64BitInstallMode; Components: main; Flags: ignoreversion
Source: "..\pack\tweego-x86.exe"; DestDir: "{app}"; Check: "not Is64BitInstallMode"; Components: main; Flags: ignoreversion
Source: "..\pack\LICENSE.txt"; DestDir: "{app}"; Components: main
Source: "..\pack\README.html"; DestDir: "{app}"; Components: readme
Source: "..\pack\story-formats\harlowe-1\*"; DestDir: "{app}\story-formats\harlowe-1"; Components: formats\harlowe1; Flags: ignoreversion
Source: "..\pack\story-formats\harlowe-2\*"; DestDir: "{app}\story-formats\harlowe-2"; Components: formats\harlowe2; Flags: ignoreversion
Source: "..\pack\story-formats\harlowe-3\*"; DestDir: "{app}\story-formats\harlowe-13"; Components: formats\harlowe3; Flags: ignoreversion
Source: "..\pack\story-formats\sugarcube-1\*"; DestDir: "{app}\story-formats\sugarcube-1"; Components: formats\sugarcube1; Flags: ignoreversion
Source: "..\pack\story-formats\sugarcube-2\*"; DestDir: "{app}\story-formats\sugarcube-2"; Components: formats\sugarcube2; Flags: ignoreversion
Source: "..\pack\story-formats\snowman-1\*"; DestDir: "{app}\story-formats\snowman-1"; Components: formats\snowman1; Flags: ignoreversion
Source: "..\pack\story-formats\paperthin-1\*"; DestDir: "{app}\story-formats\paperthin-1"; Components: formats\paperthin1; Flags: ignoreversion

[Run]
Filename: "{app}\README.html"; Description: "View the README file"; Flags: postinstall shellexec skipifsilent runasoriginaluser
Filename: "http://www.motoslave.net/tweego/docs/"; Description: "View the documentation for Tweego"; Flags: postinstall shellexec skipifsilent runasoriginaluser
File renamed without changes.

0 comments on commit 7ec9b9b

Please sign in to comment.