diff options
| author | Jakob Stendahl <14180120+JakobST1n@users.noreply.github.com> | 2021-10-11 20:02:04 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-11 20:02:04 +0200 |
| commit | c67531161e56488166a33232f87566309ba8676e (patch) | |
| tree | 846e59a020e80bea48557d5a06af5728e44961ff /public/docs/Code Documentation/Run | |
| parent | e6880cd8ccf82d993f222cb14b4860581654acb8 (diff) | |
| parent | c1b6eec770b885a9829e1f62bad5cc99389ca429 (diff) | |
| download | Luxcena-Neo-c67531161e56488166a33232f87566309ba8676e.tar.gz Luxcena-Neo-c67531161e56488166a33232f87566309ba8676e.zip | |
Merge pull request #24 from JakobST1n/rebuild
v1.0.0
Diffstat (limited to 'public/docs/Code Documentation/Run')
| -rw-r--r-- | public/docs/Code Documentation/Run/index.html | 754 |
1 files changed, 754 insertions, 0 deletions
diff --git a/public/docs/Code Documentation/Run/index.html b/public/docs/Code Documentation/Run/index.html new file mode 100644 index 0000000..bb572c2 --- /dev/null +++ b/public/docs/Code Documentation/Run/index.html @@ -0,0 +1,754 @@ + + + + +<!doctype html> +<html lang="en" class="no-js"> + <head> + + <meta charset="utf-8"> + <meta name="viewport" content="width=device-width,initial-scale=1"> + <meta http-equiv="x-ua-compatible" content="ie=edge"> + + + + + <meta name="lang:clipboard.copy" content="Copy to clipboard"> + + <meta name="lang:clipboard.copied" content="Copied to clipboard"> + + <meta name="lang:search.language" content="en"> + + <meta name="lang:search.pipeline.stopwords" content="True"> + + <meta name="lang:search.pipeline.trimmer" content="True"> + + <meta name="lang:search.result.none" content="No matching documents"> + + <meta name="lang:search.result.one" content="1 matching document"> + + <meta name="lang:search.result.other" content="# matching documents"> + + <meta name="lang:search.tokenizer" content="[\s\-]+"> + + <link rel="shortcut icon" href="../../assets/images/favicon.png"> + <meta name="generator" content="mkdocs-1.0.4, mkdocs-material-4.4.2"> + + + + <title>Run - Luxcena Neo Documentation</title> + + + + <link rel="stylesheet" href="../../assets/stylesheets/application.30686662.css"> + + + + + <script src="../../assets/javascripts/modernizr.74668098.js"></script> + + + + <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> + <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Roboto+Mono&display=fallback"> + <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> + + + <link rel="stylesheet" href="../../assets/fonts/material-icons.css"> + + + <link rel="stylesheet" href="../../assets/luxcena-colors.css"> + + + + + + </head> + + <body dir="ltr"> + + <svg class="md-svg"> + <defs> + + + </defs> + </svg> + <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> + <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> + <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> + + <a href="#run-when-developing" tabindex="1" class="md-skip"> + Skip to content + </a> + + + <header class="md-header" data-md-component="header"> + <nav class="md-header-nav md-grid"> + <div class="md-flex"> + <div class="md-flex__cell md-flex__cell--shrink"> + <a href="../.." title="Luxcena Neo Documentation" class="md-header-nav__button md-logo"> + + <i class="md-icon"></i> + + </a> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> + </div> + <div class="md-flex__cell md-flex__cell--stretch"> + <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> + + <span class="md-header-nav__topic"> + Luxcena Neo Documentation + </span> + <span class="md-header-nav__topic"> + + Run + + </span> + + </div> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + + <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> + +<div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> + <label class="md-icon md-search__icon" for="__search"></label> + <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> +  + </button> + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="result"> + <div class="md-search-result__meta"> + Type to start searching + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + </div> + + </div> + </nav> +</header> + + <div class="md-container"> + + + + + <main class="md-main" role="main"> + <div class="md-main__inner md-grid" data-md-component="container"> + + + <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + <nav class="md-nav md-nav--primary" data-md-level="0"> + <label class="md-nav__title md-nav__title--site" for="__drawer"> + <a href="../.." title="Luxcena Neo Documentation" class="md-nav__button md-logo"> + + <i class="md-icon"></i> + + </a> + Luxcena Neo Documentation + </label> + + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + <li class="md-nav__item"> + <a href="../.." title="Introduction" class="md-nav__link"> + Introduction + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../FuturePlan/" title="Plan for the future" class="md-nav__link"> + Plan for the future + </a> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> + + <label class="md-nav__link" for="nav-3"> + Usage + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-3"> + Usage + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Usage/Install/" title="Install" class="md-nav__link"> + Install + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Usage/Configuration/" title="Configuration" class="md-nav__link"> + Configuration + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Usage/CLI/" title="CLI" class="md-nav__link"> + CLI + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4"> + + <label class="md-nav__link" for="nav-4"> + Scripting + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-4"> + Scripting + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/SupportLib/" title="Support Library" class="md-nav__link"> + Support Library + </a> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-2" type="checkbox" id="nav-4-2"> + + <label class="md-nav__link" for="nav-4-2"> + Examples + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> + <label class="md-nav__title" for="nav-4-2"> + Examples + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../../Scripting/Examples/strandtest/" title="Strandtest" class="md-nav__link"> + Strandtest + </a> + </li> + + + </ul> + </nav> + </li> + + + </ul> + </nav> + </li> + + + + + + + + + + <li class="md-nav__item md-nav__item--active md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5" checked> + + <label class="md-nav__link" for="nav-5"> + Code Documentation + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> + <label class="md-nav__title" for="nav-5"> + Code Documentation + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-1" type="checkbox" id="nav-5-1"> + + <label class="md-nav__link" for="nav-5-1"> + Modules + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> + <label class="md-nav__title" for="nav-5-1"> + Modules + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link"> + CompileAndRun + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + + + <li class="md-nav__item md-nav__item--active"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> + + + + + <label class="md-nav__link md-nav__link--active" for="__toc"> + Run + </label> + + <a href="./" title="Run" class="md-nav__link md-nav__link--active"> + Run + </a> + + +<nav class="md-nav md-nav--secondary"> + + + + + + <label class="md-nav__title" for="__toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#build-watcher" class="md-nav__link"> + Build watcher. + </a> + +</li> + + <li class="md-nav__item"> + <a href="#node-watcher" class="md-nav__link"> + Node watcher + </a> + +</li> + + <li class="md-nav__item"> + <a href="#webpack" class="md-nav__link"> + webpack + </a> + + <nav class="md-nav"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#exit" class="md-nav__link"> + Exit + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#edit-file-watchers" class="md-nav__link"> + Edit file-watchers. + </a> + +</li> + + + + + + </ul> + +</nav> + + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../Design/" title="Design" class="md-nav__link"> + Design + </a> + </li> + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5-4" type="checkbox" id="nav-5-4"> + + <label class="md-nav__link" for="nav-5-4"> + API + </label> + <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> + <label class="md-nav__title" for="nav-5-4"> + API + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + + + <li class="md-nav__item"> + <a href="../SocketIO/" title="Socket-IO" class="md-nav__link"> + Socket-IO + </a> + </li> + + + </ul> + </nav> + </li> + + + </ul> + </nav> + </li> + + + </ul> +</nav> + </div> + </div> + </div> + + + <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + +<nav class="md-nav md-nav--secondary"> + + + + + + <label class="md-nav__title" for="__toc">Table of contents</label> + <ul class="md-nav__list" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#build-watcher" class="md-nav__link"> + Build watcher. + </a> + +</li> + + <li class="md-nav__item"> + <a href="#node-watcher" class="md-nav__link"> + Node watcher + </a> + +</li> + + <li class="md-nav__item"> + <a href="#webpack" class="md-nav__link"> + webpack + </a> + + <nav class="md-nav"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#exit" class="md-nav__link"> + Exit + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#edit-file-watchers" class="md-nav__link"> + Edit file-watchers. + </a> + +</li> + + + + + + </ul> + +</nav> + </div> + </div> + </div> + + + <div class="md-content"> + <article class="md-content__inner md-typeset"> + + + + <h1 id="run-when-developing">Run when developing</h1> +<p>I have made a simple script, that can be run both on a rPI and a normal computer. +(You will obviously not get any script to do anything on you pc)</p> +<p>I have only tested this on my mac...</p> +<p>To start it run: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>npm run dev +</pre></div> +</td></tr></table> +You have to run these commands beforehand: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 +2</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>npm i +pip3 install mkdocs mkdocs-gitbook pygments pymdown-extensions +</pre></div> +</td></tr></table></p> +<div class="admonition warning"> +<p class="admonition-title">Starting</p> +<p>It will when starting freak out a little. All the filewatchers fires an event for every file, +they find for some reason. But node should be killed each time, and when you end up with +only two processes, it should work as you'd expect.</p> +</div> +<p>This will create a folder named <code class="codehilite"><span class="n">tmp</span></code> in you working directory. where all the user-files will be stored.</p> +<h2 id="build-watcher">Build watcher.</h2> +<p>It starts to watch these directories: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="o">-</span> <span class="o">/</span><span class="n">build</span><span class="o">/</span> +</pre></div> +</td></tr></table> +If a change is detected, it runs: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>mkdocs build +</pre></div> +</td></tr></table></p> +<h2 id="node-watcher">Node watcher</h2> +<p>It starts to watch these directories: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 +2</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="o">-</span> <span class="n">src</span><span class="o">/</span> <span class="p">(</span><span class="k">Except</span> <span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="k">public</span><span class="o">/</span> <span class="k">and</span> <span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">js</span><span class="o">/</span><span class="p">)</span> +<span class="o">-</span> <span class="n">app</span><span class="p">.</span><span class="n">js</span> +</pre></div> +</td></tr></table></p> +<p>It then shuts down node and starts it again: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>node app.js <WORKING_DIR>/tmp/ +</pre></div> +</td></tr></table></p> +<h2 id="webpack">webpack</h2> +<p>It just starts this command, witch rebundles when anything is changed: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>npx webpack -p -w --mode<span class="o">=</span>development +</pre></div> +</td></tr></table></p> +<div class="admonition tip"> +<p class="admonition-title">Tip</p> +<p>All the log-windows respond to holding your cursor over and scrolling.</p> +</div> +<h3 id="exit"><code class="codehilite"><span class="k">Exit</span></code></h3> +<p>The script will exit when pressing <code class="codehilite"><span class="n">q</span></code>, <code class="codehilite"><span class="n">s</span></code>, <code class="codehilite"><span class="k">escape</span></code>, <code class="codehilite"><span class="n">Control</span><span class="o">+</span><span class="k">c</span></code>. +It will then send a kill signal to all processes, wait 10 seconds and then exit.</p> +<h2 id="edit-file-watchers">Edit file-watchers.</h2> +<p>Each of the file-watchers have explanatory names: <code class="codehilite"><span class="n">watcher_node</span></code> and <code class="codehilite"><span class="n">watcher_docs</span></code>.</p> +<p>To add files or paths they should watch, find the init of the variable, and modify that code: +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 +2 +3 +4 +5 +6</pre></div></td><td class="code"><div class="codehilite"><pre><span></span><span class="nx">e</span><span class="p">.</span><span class="nx">g</span><span class="p">.</span> +<span class="kd">let</span><span class="p">;</span> <span class="nx">watcher_node</span> <span class="o">=</span> <span class="nx">chokidar</span><span class="p">.</span><span class="nx">watch</span><span class="p">([</span> + <span class="s2">"app.js"</span><span class="p">,</span> + <span class="s1">'src/'</span> <span class="c1">// Add new entrys here</span> + +<span class="p">]).</span><span class="nx">on</span><span class="p">(</span><span class="s1">'all'</span><span class="p">,</span> <span class="p">(</span><span class="nx">event</span><span class="p">,</span> <span class="nx">path</span><span class="p">)</span> <span class="p">=></span> <span class="p">{</span> <span class="c1">// ...</span> +</pre></div> +</td></tr></table></p> +<p>For the node-watcher, specify paths it should ignore in the <code class="codehilite"><span class="n">path</span><span class="p">.</span><span class="n">includes</span></code> block.</p> + + + + + + + + + + </article> + </div> + </div> + </main> + + +<footer class="md-footer"> + + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + + <a href="../Modules/CompileAndRun/" title="CompileAndRun" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> + </div> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Previous + </span> + CompileAndRun + </span> + </div> + </a> + + + <a href="../Design/" title="Design" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> + <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Next + </span> + Design + </span> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> + </div> + </a> + + </nav> + </div> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + + powered by + <a href="https://www.mkdocs.org">MkDocs</a> + and + <a href="https://squidfunk.github.io/mkdocs-material/"> + Material for MkDocs</a> + </div> + + </div> + </div> +</footer> + + </div> + + <script src="../../assets/javascripts/application.c648116f.js"></script> + + <script>app.initialize({version:"1.0.4",url:{base:"../.."}})</script> + + <script src="../../assets/luxcena-colors.js"></script> + + <script src="../../assets/webfont.js"></script> + + <script src="../../assets/snap.svg-min.js"></script> + + <script src="../../assets/underscore-min.js"></script> + + <script src="../../assets/sequence-diagram.min.js"></script> + + <script src="../../assets/js-sequence.js"></script> + + + </body> +</html>
\ No newline at end of file |