1
Fork 0
mirror of https://github.com/RYGhub/royalnet.git synced 2024-11-23 19:44:20 +00:00

Small docs change

This commit is contained in:
Steffo 2019-10-09 15:07:00 +02:00
parent 0ee9f12d8a
commit 82dca094f3
6 changed files with 36 additions and 4 deletions

Binary file not shown.

View file

@ -59,4 +59,14 @@ Now that all tokens are configured, you're ready to launch the bot!
Running the bots Running the bots
------------------------------------ ------------------------------------
TODO You can run the main ``royalnet`` process by running: ::
python3.7 -m royalnet
To see all available options, you can run: ::
python3.7 -m royalnet --help
.. note:: All royalnet options should be specified **after** the word ``royalnet``, or else they will be passed to
the Python interpreter.

View file

@ -203,7 +203,19 @@ The token should be of type “anonymous usage without user authorization”.</p
</div> </div>
<div class="section" id="running-the-bots"> <div class="section" id="running-the-bots">
<h2>Running the bots<a class="headerlink" href="#running-the-bots" title="Permalink to this headline"></a></h2> <h2>Running the bots<a class="headerlink" href="#running-the-bots" title="Permalink to this headline"></a></h2>
<p>TODO</p> <p>You can run the main <code class="docutils literal notranslate"><span class="pre">royalnet</span></code> process by running:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span><span class="o">.</span><span class="mi">7</span> <span class="o">-</span><span class="n">m</span> <span class="n">royalnet</span>
</pre></div>
</div>
<p>To see all available options, you can run:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">python3</span><span class="o">.</span><span class="mi">7</span> <span class="o">-</span><span class="n">m</span> <span class="n">royalnet</span> <span class="o">--</span><span class="n">help</span>
</pre></div>
</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>All royalnet options should be specified <strong>after</strong> the word <code class="docutils literal notranslate"><span class="pre">royalnet</span></code>, or else they will be passed to
the Python interpreter.</p>
</div>
</div> </div>
</div> </div>

File diff suppressed because one or more lines are too long

View file

@ -59,4 +59,14 @@ Now that all tokens are configured, you're ready to launch the bot!
Running the bots Running the bots
------------------------------------ ------------------------------------
TODO You can run the main ``royalnet`` process by running: ::
python3.7 -m royalnet
To see all available options, you can run: ::
python3.7 -m royalnet --help
.. note:: All royalnet options should be specified **after** the word ``royalnet``, or else they will be passed to
the Python interpreter.