diff options
| author | Jakob Stendahl <jakob.stendahl@outlook.com> | 2021-09-19 19:43:11 +0200 |
|---|---|---|
| committer | Jakob Stendahl <jakob.stendahl@outlook.com> | 2021-09-19 19:43:11 +0200 |
| commit | 7bdce37fd3f18e2712e18c4e2c64cac69af0aca1 (patch) | |
| tree | b7ad3f1cca92e2dfd2664ae9e65652bd03ff58b2 /public/docs/Usage/Install | |
| parent | e6880cd8ccf82d993f222cb14b4860581654acb8 (diff) | |
| download | Luxcena-Neo-7bdce37fd3f18e2712e18c4e2c64cac69af0aca1.tar.gz Luxcena-Neo-7bdce37fd3f18e2712e18c4e2c64cac69af0aca1.zip | |
:boom: Introduce new UI based on svelte, and rewrite a lot of the node app and the NeoRuntime
Diffstat (limited to 'public/docs/Usage/Install')
| -rw-r--r-- | public/docs/Usage/Install/index.html | 682 |
1 files changed, 682 insertions, 0 deletions
diff --git a/public/docs/Usage/Install/index.html b/public/docs/Usage/Install/index.html new file mode 100644 index 0000000..9da9810 --- /dev/null +++ b/public/docs/Usage/Install/index.html @@ -0,0 +1,682 @@ + + + + +<!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>Install - 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="#installation" 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"> + + Install + + </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--active md-nav__item--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3" checked> + + <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 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"> + Install + </label> + + <a href="./" title="Install" class="md-nav__link md-nav__link--active"> + Install + </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="#requirements" class="md-nav__link"> + Requirements + </a> + +</li> + + <li class="md-nav__item"> + <a href="#install" class="md-nav__link"> + Install + </a> + +</li> + + <li class="md-nav__item"> + <a href="#troubleshooting" class="md-nav__link"> + Troubleshooting + </a> + +</li> + + + + + + </ul> + +</nav> + + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../Configuration/" title="Configuration" class="md-nav__link"> + Configuration + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../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--nested"> + + <input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5"> + + <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="../../Code Documentation/Modules/CompileAndRun/" title="CompileAndRun" class="md-nav__link"> + CompileAndRun + </a> + </li> + + + </ul> + </nav> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Code Documentation/Run/" title="Run" class="md-nav__link"> + Run + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../Code Documentation/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="../../Code Documentation/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="#requirements" class="md-nav__link"> + Requirements + </a> + +</li> + + <li class="md-nav__item"> + <a href="#install" class="md-nav__link"> + Install + </a> + +</li> + + <li class="md-nav__item"> + <a href="#troubleshooting" class="md-nav__link"> + Troubleshooting + </a> + +</li> + + + + + + </ul> + +</nav> + </div> + </div> + </div> + + + <div class="md-content"> + <article class="md-content__inner md-typeset"> + + + + <h1 id="installation">Installation</h1> +<p>If you want to install luxcena-neo to use it, these are the instructions:</p> +<hr /> +<h2 id="requirements">Requirements</h2> +<ul> +<li>The luxcena-shield</li> +<li>Access to the raspberry pi (SSH or direct)</li> +<li>Root access (preferably through the <code class="codehilite"><span class="n">sudo</span></code> command)</li> +</ul> +<h2 id="install">Install</h2> +<ol> +<li>Start with logging into your Raspberry Pi</li> +<li>Run these commands +<table class="codehilitetable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span>1 +2 +3</pre></div></td><td class="code"><div class="codehilite"><pre><span></span>git clone https://github.com/JakobST1n/Luxcena-Neo +<span class="nb">cd</span> Luxcena-Neo +sudo ./bin/install.sh +</pre></div> +</td></tr></table></li> +<li>Follow the instructions on screen. You should answer yes to most of the questions.</li> +<li>The install-process might seem to hang, but there is just no output being sent to the console. If you want to see a bit more verbose output. Open another terminal session, and run this command: +<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>tail -n <span class="m">10</span> -f /tmp/luxcena-neo.install.log +</pre></div> +</td></tr></table> +This is also where you will find possible reasons for a failed install.</li> +<li>Luxcena-Neo should now be installed. Start it with this command +<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>luxcena-neo start +</pre></div> +</td></tr></table></li> +</ol> +<div class="admonition default user"> +<p class="admonition-title">neo":"luxcena-neo</p> +</div> +<h2 id="troubleshooting">Troubleshooting</h2> +<p>We haven't encountered any troubles yet, but once we do, we will post fix'es here.</p> +<hr /> +<p>You should now be all set to <a href="/Usage/Configuration.md">configuring luxcena-neo</a>.</p> + + + + + + + + + + </article> + </div> + </div> + </main> + + +<footer class="md-footer"> + + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + + <a href="../../FuturePlan/" title="Plan for the future" 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> + Plan for the future + </span> + </div> + </a> + + + <a href="../Configuration/" title="Configuration" 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> + Configuration + </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 |