Skip to content

Commit

Permalink
Merge branch 'documentation' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
RVRX committed Jun 28, 2021
2 parents 263b4e9 + dd64e50 commit b240c7c
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
<nav class="navbar navbar-dark bg-dark sticky-top shadow navbar-expand" style="background-color: #313045 !important;" id="navigation">
<div class="container-fluid">
<a class="navbar-brand" href="#">
<img src="logo.png" alt="" width="30" height="24" class="d-inline-block align-text-top">
<img src="splash-ubersmall.png" alt="" width="30" height="24" class="d-inline-block align-text-top">
GoISTR
</a>
<button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
Expand All @@ -77,10 +77,11 @@
<ul class="navbar-nav me-auto mb-2 mb-lg-0">
<li class="nav-item"><a class="nav-link" href="#application-overview">Overview</a></li>
<li class="nav-item"><a class="nav-link" href="#features">Features</a></li>
<li class="nav-item"><a class="nav-link" href="#downloads">Downloads</a></li>
<li class="nav-item"><a class="nav-link" href="#usage-overview">Usage</a></li>
<li class="nav-item"><a class="nav-link" href="#contributing">Contributing</a></li>
<form class="container-fluid justify-content-start" action="https://github.com/RVRX/GoIStreamToolRedux/releases/latest">
<button class="btn me-2 btn-outline-light" type="submit" style="background-color: #35344b; color: aliceblue; outline: aliceblue 3px">Download</button>
<button class="btn me-2 btn-outline-light" type="submit" style="background-color: #35344b; color: aliceblue; outline: aliceblue 3px">Latest Release</button>
</form>
</ul>
</div>
Expand All @@ -90,9 +91,10 @@
<div class="container" id="main-container">
<div class="row" id="main-row">
<div class="col">
<h1 id="application-overview">Overview</h1>
<p>GoIStreamToolRedux (GoISTR) is a cross-platform application designed to assist <a href="https://gunsoficarus.com/" target="_blank">Guns of Icarus</a> tournament broadcasters with their interfaces and overlays. It includes UI management for teams, maps, timers, and tournament info that all ties into an output folder, providing OBS (or other casting tool) with static file paths to read from. The GoISTR project started as an adaptation of the original closed-course Windows application <a href="https://urzlab.com/goistreamtool/">GoiStreamTool</a> by GoIO player and caster Urz.</p>
<p class="text-info">GoISTR is a free and open-source software. As such, community contributions to the application source or its supporting material is welcome, and feedback is appreciated to help grow the application.</p>
<h1 id="application-overview" class="mt-3">Application Overview</h1>
<p>GoIStreamToolRedux (GoISTR) is a cross-platform application designed to assist <a href="https://gunsoficarus.com/" target="_blank">Guns of Icarus</a> tournament broadcasters with their interfaces and overlays. It includes UI management for teams, maps, timers, and tournament info that all ties into an output folder, providing OBS (or other casting tool) with static file paths to read from. The GoISTR project started as an adaptation of the original closed-course Windows application <a href="https://urzlab.com/goistreamtool/" target="_blank">GoiStreamTool</a> by GoIO player and caster Urz.</p>
<p>GoISTR is a free and open-source software. As such, community contributions to the application source and its supporting material is welcome, and feedback is appreciated to help grow the application. See <a href="#contributing">contributing</a> for more info.</p>
<p class="text-warning">The software is still in development and testing phases. No future download is guaranteed to be more stable than past downloads, until release <em>v1.0</em>. Backing up input and output folders is recommended.</p>

<h1 id="features">Features</h1>

Expand All @@ -111,9 +113,33 @@ <h3 id="map-management">Map Management</h3>
<h3 id="tournament-info">Tournament Info</h3>
<p>Set the current tournament number. <em>More tournament features are planned for future.</em></p>
<img class="img-fluid" width="812" alt="image" src="https://user-images.githubusercontent.com/45409688/123658789-09be5400-d800-11eb-9591-3e6c2b1f5b0d.png">
<div id="downloads" class="mb-5"></div>


<h1>Downloads</h1>
<div class="row">
<div class="col">
<h4 class="display-4">Stable Release</h4>
<p class="lead">Solely the native executable</p>
<ul class="list-group list-group-flush">
<li class="list-group-item">Mac: <a href="#TODO">GoIStreamTool-v0.4.app.zip</a></li>
<li class="list-group-item">Windows: <a href="#TODO">GoIStreamTool-v0.4.exe</a></li>
<li class="list-group-item">Packaged Jar: <a href="#TODO">GoIStreamTool-0.4.jar</a></li>
</ul>
</div>
<div class="col">
<h4 class="display-4">Map & Team Bundle</h4>
<p class="lead">Pre-built input folder</p>
<ul class="list-group list-group-flush">
<li class="list-group-item">Input Folder: <a href="http://skyborne.net/input.zip">input.zip</a></li>
<li class="list-group-item"><h6 class="mt-4 text-primary"><a href="https://github.com/RVRX/GoIStreamToolRedux/releases">For the <em>latest</em> releases (and for patch notes), please check the GitHub</a>.</h6>
</li>
</ul>
</div>
</div>


<br>
<br><br>
<h1 id="usage">Usage</h1>
<h2 id="usage-overview">Overview</h2>
<p>
Expand Down
Binary file added docs/splash-ubersmall.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b240c7c

Please sign in to comment.