<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Quickstart — inkycal 2.0.3 documentation</title> <link rel="stylesheet" href="_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <!--[if lt IE 9]> <script src="_static/js/html5shiv.min.js"></script> <![endif]--> <script src="_static/jquery.js"></script> <script src="_static/_sphinx_javascript_frameworks_compat.js"></script> <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> <script src="_static/doctools.js"></script> <script src="_static/sphinx_highlight.js"></script> <script src="_static/js/theme.js"></script> <link rel="author" title="About these documents" href="about.html" /> <link rel="index" title="Index" href="genindex.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Developer documentation" href="dev_doc.html" /> <link rel="prev" title="About Inkycal" href="about.html" /> </head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="index.html" class="icon icon-home"> inkycal </a> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> <p class="caption" role="heading"><span class="caption-text">Contents:</span></p> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="inkycal.html">Inkycal</a></li> <li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.display.display">Display</a></li> <li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.custom.functions">Custom functions</a></li> <li class="toctree-l1"><a class="reference internal" href="inkycal.html#module-inkycal.modules.ical_parser">Helper classes</a></li> <li class="toctree-l1"><a class="reference internal" href="about.html">About Inkycal</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Quickstart</a><ul> <li class="toctree-l2"><a class="reference internal" href="#installing-inkycal">Installing Inkycal</a></li> <li class="toctree-l2"><a class="reference internal" href="#creating-settings-file">Creating settings file</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="dev_doc.html">Developer documentation</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">inkycal</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Quickstart</li> <li class="wy-breadcrumbs-aside"> <a href="_sources/quickstart.md.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <section id="quickstart"> <h1>Quickstart<a class="headerlink" href="#quickstart" title="Permalink to this heading"></a></h1> <img align="center" src="https://raw.githubusercontent.com/aceinnolab/Inkycal/assets/Repo/logo.png" width="800"><section id="installing-inkycal"> <h2>Installing Inkycal<a class="headerlink" href="#installing-inkycal" title="Permalink to this heading"></a></h2> <p>Install inkycal directly via the GitHub repo:</p> <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span><span class="c1"># clone the repo</span> git<span class="w"> </span>clone<span class="w"> </span>https://github.com/aceinnolab/Inkycal <span class="c1"># go to downloaded repo folder</span> <span class="nb">cd</span><span class="w"> </span>Inkycal <span class="c1"># install Inkycal</span> pip3<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>./ </pre></div> </div> </section> <section id="creating-settings-file"> <h2>Creating settings file<a class="headerlink" href="#creating-settings-file" title="Permalink to this heading"></a></h2> <p>Please navigate to the <a class="reference external" href="https://aceisace.eu.pythonanywhere.com/index">WEB-UI</a> to create your settings file.</p> <p>Copy the generated settings file to the Raspberry Pi more coming soon..</p> </section> </section> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="about.html" class="btn btn-neutral float-left" title="About Inkycal" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> <a href="dev_doc.html" class="btn btn-neutral float-right" title="Developer documentation" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> </div> <hr/> <div role="contentinfo"> <p>© Copyright 2018-2023, aceinnolab.</p> </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>