RubyGems - netlinx-compile - Versions diffs - 1.0.0 → 3.1.2 - Mend

netlinx-compile 1.0.0 → 3.1.2

Files changed (84) hide show

checksums.yaml +5 -5
data/README.md +122 -0
data/doc/NetLinx.html +130 -151
data/doc/NetLinx/Compile.html +130 -148
data/doc/NetLinx/Compile/Extension.html +128 -145
data/doc/NetLinx/Compile/Extension/AXS.html +218 -154
data/doc/NetLinx/Compile/ExtensionDiscovery.html +524 -321
data/doc/NetLinx/Compile/ExtensionHandler.html +755 -396
data/doc/NetLinx/Compile/Script.html +431 -282
data/doc/NetLinx/Compiler.html +496 -285
data/doc/NetLinx/CompilerResult.html +1250 -498
data/doc/NetLinx/NoCompilerError.html +142 -155
data/doc/NetLinx/Rake.html +115 -0
data/doc/NetLinx/Rake/Compile.html +358 -0
data/doc/NetLinx/SourceFile.html +702 -423
data/doc/_index.html +234 -0
data/doc/class_list.html +51 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +58 -0
data/doc/css/style.css +496 -0
data/doc/file.README.html +156 -0
data/doc/file.license.html +70 -0
data/doc/file_list.html +61 -0
data/doc/frames.html +17 -0
data/doc/index.html +156 -103
data/doc/js/app.js +314 -0
data/doc/js/full_list.js +216 -0
data/doc/js/jquery.js +4 -18
data/doc/method_list.html +339 -0
data/doc/top-level-namespace.html +110 -0
data/lib/netlinx-compile.rb +11 -1
data/lib/netlinx/compile/extension_discovery.rb +4 -2
data/lib/netlinx/compile/extension_handler.rb +23 -25
data/lib/netlinx/compile/script.rb +4 -3
data/lib/netlinx/compiler.rb +45 -21
data/lib/netlinx/compiler_result.rb +16 -17
data/lib/netlinx/rake/compile.rb +4 -0
data/lib/netlinx/rake/compile/compile.rb +34 -0
data/lib/netlinx/source_file.rb +20 -14
data/lib/test/netlinx/compilable.rb +13 -48
data/lib/test/netlinx/compile/discoverable.rb +3 -14
data/lib/test/netlinx/compile/invokable.rb +3 -15
data/license.txt +1 -1
metadata +114 -74
data/README.txt +0 -2
data/doc/Test.html +0 -147
data/doc/Test/NetLinx.html +0 -147
data/doc/Test/NetLinx/Compilable.html +0 -148
data/doc/Test/NetLinx/Compile.html +0 -146
data/doc/Test/NetLinx/Compile/Discoverable.html +0 -148
data/doc/Test/NetLinx/Compile/Invokable.html +0 -149
data/doc/created.rid +0 -12
data/doc/images/add.png +0 -0
data/doc/images/arrow_up.png +0 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/delete.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_blue.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/transparent.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/js/darkfish.js +0 -155
data/doc/js/navigation.js +0 -142
data/doc/js/search.js +0 -94
data/doc/js/search_index.js +0 -1
data/doc/js/searcher.js +0 -228
data/doc/rdoc.css +0 -595
data/doc/table_of_contents.html +0 -138

@@ -0,0 +1,156 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: README
+    &mdash; Documentation by YARD 0.9.25
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "README";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="file_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: README</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><div id='filecontents'>
+<h1 id="label-NetLinx+Compile">NetLinx Compile</h1>
+<p>netlinx-compile</p>
+<p>A wrapper utility for the AMX NetLinx compiler.</p>
+<p><a href="http://badge.fury.io/rb/netlinx-compile"><img src="https://badge.fury.io/rb/netlinx-compile.png"></a> <a href="http://www.rubydoc.info/gems/netlinx-compile"><img src="https://img.shields.io/badge/docs-api-blue.svg"></a> <a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%202.0-yellowgreen.svg"></a></p>
+<p>This library provides an executable, <code>netlinx-compile</code>, that wraps the <code>nlrc.exe</code> NetLinx compiler provided by AMX. It is designed for easier command line access, as well as for integration with third-party tools with source code build support, like text editors and IDE&#39;s. Also provided in this library is a Ruby API for invoking the NetLinx compiler.</p>
+<h2 id="label-Upgrade+Notice">Upgrade Notice</h2>
+<p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0 (distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4 versions less than 4.1.1204, and has major problems. It is recommended to <em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in NetLinx Studio v4.1.1204 and appears to have <a href="https://github.com/amclain/netlinx-compile/issues/1">fixed the problems when compiling include and Duet files</a>. Due to the major changes in the NetLinx compiler, it may be necessary to use version 1.x of netlinx-compile when working with projects created with NetLinx Studio v3.x or earlier.</p>
+<ul><li>
+<p>Version 1.x of netlinx-compile targets NLRC.exe v1.x.</p>
+</li><li>
+<p>NLRC.exe v2.x is considered broken and is unsupported by netlinx-compile.</p>
+</li><li>
+<p>Version 3.x of netlinx-compile targets NLRC.exe v3.x.</p>
+</li></ul>
+<p><a href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX NetLinx Compiler Bug List</a></p>
+<h2 id="label-Installation">Installation</h2>
+<p>netlinx-compile is available as a Ruby gem.</p>
+<ol><li>
+<p>Install <a href="http://www.ruby-lang.org/en/downloads/">Ruby</a> 2.0 or higher (For Windows use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a> and make sure ruby/bin is in your <a href="http://www.computerhope.com/issues/ch000549.htm">system path</a>.)</p>
+</li><li>
+<p>Open the <a href="http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/">command line</a> and type:</p>
+</li></ol>
+<pre class="code ruby"><code class="ruby">gem install netlinx-compile
+    gem install netlinx-workspace (optional: for NetLinx Studio workspace support)
+</code></pre>
+<p><em>NOTE: The NetLinx compiler executable provided by AMX, nlrc.exe, must be installed on your computer for this utility to work. It is included in the NetLinx Studio installation by default.</em></p>
+<p><strong>If you receive the following error when running gem install:</strong> <code>Unable to download data from https://rubygems.org/ - SSL_connect returned=1</code></p>
+<p>Follow this guide: <a href="https://gist.github.com/luislavena/f064211759ee0f806c88">Workaround RubyGems’ SSL errors on Ruby for Windows (RubyInstaller)</a></p>
+<h2 id="label-Issues-2C+Bugs-2C+Feature+Requests">Issues, Bugs, Feature Requests</h2>
+<p>Any bugs and feature requests should be reported on the GitHub issue tracker:</p>
+<p><a href="https://github.com/amclain/netlinx-compile/issues">github.com/amclain/netlinx-compile/issues</a></p>
+<p><strong>Pull requests are preferred via GitHub.</strong></p>
+<h2 id="label-Use">Use</h2>
+<p><strong>Sublime Text Editor</strong></p>
+<p>NetLinx Compile can be integrated into <a href="http://www.sublimetext.com/3">Sublime Text</a> with the <a href="https://github.com/amclain/sublime-netlinx">Sublime Text AMX NetLinx Plugin</a>. This allows NetLinx source code and workspaces to be compiled with the editor&#39;s built-in build commands.</p>
+<p><strong>Command Line</strong></p>
+<p>NetLinx Compile provides friendlier command line access than the traditional NetLinx compiler provided by AMX. For starters, files can now be entered by relative path (<code>my_file.axs</code>) as well as absolute path (<code>c:\path\to\my_file.axs</code>). A more advanced feature, workspace compiling, can invoke the NetLinx compiler on a workspace file, as well as intelligently seek out a workspace for a given source code file.</p>
+<p>Compile a source code file.</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -s my_source_code.axs
+</code></pre>
+<p>Compile a workspace (with <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> installed).</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -s my_workspace.apw
+</code></pre>
+<p>Find the workspace that contains my_source_code.axs and compile it.</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -w -s my_source_code.axs
+</code></pre>
+<p>Print all of the option flags and their descriptions.</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -h
+</code></pre>
+<p><strong>Ruby Developer API</strong></p>
+<p>A Ruby API is provided for developers looking to integrate the NetLinx Compile library into thier own tools. <a href="http://rubydoc.info/gems/netlinx-compile/frames">NetLinx Compile Developer Documentation</a></p>
+<p>NetLinx Compile supports the ability to invoke the compiler on third-party files, like when creating new types of workspaces. To add NetLinx Compile support to your Ruby gem, create a handler for your file extension under the namespace NetLinx::Compile::Extension, place the .rb file under lib/netlinx/compile/extension in your gem, and add a dependency or development dependency in your gemspec to the netlinx-compile gem. NetLinx Compile will now automatically use your gem to compile the file extension it specifies. This is implemented in NetLinx::Compile::Extension::AXS, as well as in the <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> gem.</p>
+</div></div>
+      <div id="footer">
+  Generated on Sat Jul 11 17:29:50 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.25 (ruby-2.7.1).
+</div>
+    </div>
+  </body>
+</html>

data/doc/file.license.html ADDED

@@ -0,0 +1,70 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: license
+    &mdash; Documentation by YARD 0.9.25
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "license";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="file_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: license</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><div id='filecontents'>Copyright 2013, 2015 Alex McLain<br/><br/>Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);<br/>you may not use this file except in compliance with the License.<br/>You may obtain a copy of the License at<br/><br/> http://www.apache.org/licenses/LICENSE-2.0<br/><br/>Unless required by applicable law or agreed to in writing, software<br/>distributed under the License is distributed on an &quot;AS IS&quot; BASIS,<br/>WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<br/>See the License for the specific language governing permissions and<br/>limitations under the License.</div></div>
+      <div id="footer">
+  Generated on Sat Jul 11 17:29:50 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.25 (ruby-2.7.1).
+</div>
+    </div>
+  </body>
+</html>

data/doc/file_list.html ADDED

@@ -0,0 +1,61 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <meta charset="utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
+      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <title>File List</title>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <div id="content">
+      <div class="fixed_header">
+        <h1 id="full_list_header">File List</h1>
+        <div id="full_list_nav">
+            <span><a target="_self" href="class_list.html">
+              Classes
+            </a></span>
+            <span><a target="_self" href="method_list.html">
+              Methods
+            </a></span>
+            <span><a target="_self" href="file_list.html">
+              Files
+            </a></span>
+        </div>
+        <div id="search">Search: <input type="text" /></div>
+      </div>
+      <ul id="full_list" class="file">
+  <li id="object_README" class="odd">
+    <div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
+  </li>
+  <li id="object_license" class="even">
+    <div class="item"><span class="object_link"><a href="file.license.html" title="license">license</a></span></div>
+  </li>
+      </ul>
+    </div>
+  </body>
+</html>

data/doc/frames.html ADDED

@@ -0,0 +1,17 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+	<title>Documentation by YARD 0.9.25</title>
+</head>
+<script type="text/javascript">
+  var match = unescape(window.location.hash).match(/^#!(.+)/);
+  var name = match ? match[1] : 'index.html';
+  name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
+  window.top.location = name;
+</script>
+<noscript>
+  <h1>Oops!</h1>
+  <h2>YARD requires JavaScript!</h2>
+</noscript>
+</html>

data/doc/index.html CHANGED

@@ -1,103 +1,156 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
-<title>RDoc Documentation</title>
-<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
-<script type="text/javascript">
-  var rdoc_rel_prefix = "./";
-</script>
-<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
-<body>
-<nav id="metadata">
-  <nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="./index.html">Home</a>
-    <a href="./table_of_contents.html#classes">Classes</a>
-    <a href="./table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
-  <nav id="search-section" class="section project-section" class="initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <h3 class="section-header">
-      <input type="text" name="search" placeholder="Search" id="search-field"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </h3>
-  </form>
-  <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-  <div id="project-metadata">
-    <nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
-  <ul class="link-list">
-    <li><a href="./NetLinx.html">NetLinx</a>
-    <li><a href="./NetLinx/Compile.html">NetLinx::Compile</a>
-    <li><a href="./NetLinx/Compile/Extension.html">NetLinx::Compile::Extension</a>
-    <li><a href="./NetLinx/Compile/Extension/AXS.html">NetLinx::Compile::Extension::AXS</a>
-    <li><a href="./NetLinx/Compile/ExtensionDiscovery.html">NetLinx::Compile::ExtensionDiscovery</a>
-    <li><a href="./NetLinx/Compile/ExtensionHandler.html">NetLinx::Compile::ExtensionHandler</a>
-    <li><a href="./NetLinx/Compile/Script.html">NetLinx::Compile::Script</a>
-    <li><a href="./NetLinx/Compiler.html">NetLinx::Compiler</a>
-    <li><a href="./NetLinx/CompilerResult.html">NetLinx::CompilerResult</a>
-    <li><a href="./NetLinx/NoCompilerError.html">NetLinx::NoCompilerError</a>
-    <li><a href="./NetLinx/SourceFile.html">NetLinx::SourceFile</a>
-    <li><a href="./Test.html">Test</a>
-    <li><a href="./Test/NetLinx.html">Test::NetLinx</a>
-    <li><a href="./Test/NetLinx/Compilable.html">Test::NetLinx::Compilable</a>
-    <li><a href="./Test/NetLinx/Compile.html">Test::NetLinx::Compile</a>
-    <li><a href="./Test/NetLinx/Compile/Discoverable.html">Test::NetLinx::Compile::Discoverable</a>
-    <li><a href="./Test/NetLinx/Compile/Invokable.html">Test::NetLinx::Compile::Invokable</a>
-  </ul>
-</nav>
-  </div>
-</nav>
-<div id="documentation" class="description">
-<p>This is the API documentation for RDoc Documentation.
-</div>
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
-</footer>
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  File: README
+    &mdash; Documentation by YARD 0.9.25
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "README";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">File: README</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><div id='filecontents'>
+<h1 id="label-NetLinx+Compile">NetLinx Compile</h1>
+<p>netlinx-compile</p>
+<p>A wrapper utility for the AMX NetLinx compiler.</p>
+<p><a href="http://badge.fury.io/rb/netlinx-compile"><img src="https://badge.fury.io/rb/netlinx-compile.png"></a> <a href="http://www.rubydoc.info/gems/netlinx-compile"><img src="https://img.shields.io/badge/docs-api-blue.svg"></a> <a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache%202.0-yellowgreen.svg"></a></p>
+<p>This library provides an executable, <code>netlinx-compile</code>, that wraps the <code>nlrc.exe</code> NetLinx compiler provided by AMX. It is designed for easier command line access, as well as for integration with third-party tools with source code build support, like text editors and IDE&#39;s. Also provided in this library is a Ruby API for invoking the NetLinx compiler.</p>
+<h2 id="label-Upgrade+Notice">Upgrade Notice</h2>
+<p>AMX has broken NetLinx compilier functionality between NLRC.exe v1.0 (distributed with NetLinx Studio v3.x) and NLRC.exe v2.1 (distributed with NetLinx Studio 4). NLRC.exe v2.x was distributed with NetLinx Studio 4 versions less than 4.1.1204, and has major problems. It is recommended to <em>avoid</em> NLRC.exe v2.x. NLRC.exe v3.x started being distributed in NetLinx Studio v4.1.1204 and appears to have <a href="https://github.com/amclain/netlinx-compile/issues/1">fixed the problems when compiling include and Duet files</a>. Due to the major changes in the NetLinx compiler, it may be necessary to use version 1.x of netlinx-compile when working with projects created with NetLinx Studio v3.x or earlier.</p>
+<ul><li>
+<p>Version 1.x of netlinx-compile targets NLRC.exe v1.x.</p>
+</li><li>
+<p>NLRC.exe v2.x is considered broken and is unsupported by netlinx-compile.</p>
+</li><li>
+<p>Version 3.x of netlinx-compile targets NLRC.exe v3.x.</p>
+</li></ul>
+<p><a href="https://github.com/amclain/netlinx-compile/labels/amx%20bug%20-%20can't%20fix">AMX NetLinx Compiler Bug List</a></p>
+<h2 id="label-Installation">Installation</h2>
+<p>netlinx-compile is available as a Ruby gem.</p>
+<ol><li>
+<p>Install <a href="http://www.ruby-lang.org/en/downloads/">Ruby</a> 2.0 or higher (For Windows use <a href="http://rubyinstaller.org/downloads/">RubyInstaller</a> and make sure ruby/bin is in your <a href="http://www.computerhope.com/issues/ch000549.htm">system path</a>.)</p>
+</li><li>
+<p>Open the <a href="http://www.addictivetips.com/windows-tips/windows-7-elevated-command-prompt-in-context-menu/">command line</a> and type:</p>
+</li></ol>
+<pre class="code ruby"><code class="ruby">gem install netlinx-compile
+    gem install netlinx-workspace (optional: for NetLinx Studio workspace support)
+</code></pre>
+<p><em>NOTE: The NetLinx compiler executable provided by AMX, nlrc.exe, must be installed on your computer for this utility to work. It is included in the NetLinx Studio installation by default.</em></p>
+<p><strong>If you receive the following error when running gem install:</strong> <code>Unable to download data from https://rubygems.org/ - SSL_connect returned=1</code></p>
+<p>Follow this guide: <a href="https://gist.github.com/luislavena/f064211759ee0f806c88">Workaround RubyGems’ SSL errors on Ruby for Windows (RubyInstaller)</a></p>
+<h2 id="label-Issues-2C+Bugs-2C+Feature+Requests">Issues, Bugs, Feature Requests</h2>
+<p>Any bugs and feature requests should be reported on the GitHub issue tracker:</p>
+<p><a href="https://github.com/amclain/netlinx-compile/issues">github.com/amclain/netlinx-compile/issues</a></p>
+<p><strong>Pull requests are preferred via GitHub.</strong></p>
+<h2 id="label-Use">Use</h2>
+<p><strong>Sublime Text Editor</strong></p>
+<p>NetLinx Compile can be integrated into <a href="http://www.sublimetext.com/3">Sublime Text</a> with the <a href="https://github.com/amclain/sublime-netlinx">Sublime Text AMX NetLinx Plugin</a>. This allows NetLinx source code and workspaces to be compiled with the editor&#39;s built-in build commands.</p>
+<p><strong>Command Line</strong></p>
+<p>NetLinx Compile provides friendlier command line access than the traditional NetLinx compiler provided by AMX. For starters, files can now be entered by relative path (<code>my_file.axs</code>) as well as absolute path (<code>c:\path\to\my_file.axs</code>). A more advanced feature, workspace compiling, can invoke the NetLinx compiler on a workspace file, as well as intelligently seek out a workspace for a given source code file.</p>
+<p>Compile a source code file.</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -s my_source_code.axs
+</code></pre>
+<p>Compile a workspace (with <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> installed).</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -s my_workspace.apw
+</code></pre>
+<p>Find the workspace that contains my_source_code.axs and compile it.</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -w -s my_source_code.axs
+</code></pre>
+<p>Print all of the option flags and their descriptions.</p>
+<pre class="code ruby"><code class="ruby">netlinx-compile -h
+</code></pre>
+<p><strong>Ruby Developer API</strong></p>
+<p>A Ruby API is provided for developers looking to integrate the NetLinx Compile library into thier own tools. <a href="http://rubydoc.info/gems/netlinx-compile/frames">NetLinx Compile Developer Documentation</a></p>
+<p>NetLinx Compile supports the ability to invoke the compiler on third-party files, like when creating new types of workspaces. To add NetLinx Compile support to your Ruby gem, create a handler for your file extension under the namespace NetLinx::Compile::Extension, place the .rb file under lib/netlinx/compile/extension in your gem, and add a dependency or development dependency in your gemspec to the netlinx-compile gem. NetLinx Compile will now automatically use your gem to compile the file extension it specifies. This is implemented in NetLinx::Compile::Extension::AXS, as well as in the <a href="https://github.com/amclain/netlinx-workspace">NetLinx Workspace</a> gem.</p>
+</div></div>
+      <div id="footer">
+  Generated on Sat Jul 11 17:29:50 2020 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.25 (ruby-2.7.1).
+</div>
+    </div>
+  </body>
+</html>