Skip to content

Commit

Permalink
doc: link back to source code (#12)
Browse files Browse the repository at this point in the history
  • Loading branch information
c-dilks committed Jun 5, 2024
1 parent aa1569c commit 0177efc
Showing 1 changed file with 44 additions and 32 deletions.
76 changes: 44 additions & 32 deletions .github/usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<head>
<title>clas-stringspinner usage guide</title>
<style>
body {
background-color: #002222;
color: #ffffff;
}
body {
background-color: #002222;
color: #ffffff;
}
a {
color: #00cccc;
}
Expand Down Expand Up @@ -33,36 +33,48 @@
}
</style>
</head>
<body>
<body>

<center>
<h1>clas-stringspinner Usage Guide</h1>
Source Code:&nbsp;&nbsp;
<a href="https://github.com/JeffersonLab/clas-stringspinner">clas-stringspinner</a>
&nbsp;|&nbsp;
<a href="https://gitlab.com/albikerbizi/stringspinner/-/tree/master">StringSpinner</a>
</center>

<br/>

<div class="sec">
<h2>Executable</h2>
The main executable <code>clas-stringspinner</code> is installed in <code>$install_dir/bin</code>
(unless you have changed the <code>bindir</code> build option).
See below for the <b>Usage Guide</b>, or run:
<br/><br/>
<div class="codeblock">
<pre><code>$install_dir/bin/clas-stringspinner --help</code></pre>
</div>
<ul>
<li><b>TIP:</b> For easier usage, add the installed <code>$install_dir/bin</code> directory to your <code>$PATH</code></li>
<li><b>NOTE:</b> No environment variables are required to run <code>clas-stringspinner</code></li>
</ul>
</div>

<center><h1>Running StringSpinner</h1></center>
<br/>

<div class="sec">
<h2>Executable</h2>
The main executable <code>clas-stringspinner</code> is installed in <code>$install_dir/bin</code> (unless you have changed the <code>bindir</code> build option).
See below for the <b>Usage Guide</b>, or run:<br/><br/>
<div class="codeblock">
<pre><code>$install_dir/bin/clas-stringspinner --help</code></pre>
</div>
<ul>
<li><b>TIP:</b> For easier usage, add the installed <code>$install_dir/bin</code> directory to your <code>$PATH</code></li>
<li><b>NOTE:</b> No environment variables are required to run <code>clas-stringspinner</code></li>
</ul>
</div>
<div class="sec">
<h2>Usage Guide</h2>
<div class="codeblock">
<pre><code>
@usage@
</code></pre>
</div>
</div>

<br/>
<center>Last updated:
@date@
</center>
<br/>

<div class="sec">
<h2>Usage Guide</h2>
<div class="codeblock">
<pre><code>
@usage@
</code></pre>
</div>
</div>
<center>Last updated:
@date@
</center>
<br/>
</body>
</body>
</html>

0 comments on commit 0177efc

Please sign in to comment.