mirror of
https://github.com/onionshare/onionshare.git
synced 2024-10-01 01:35:40 -04:00
Add getting help
This commit is contained in:
parent
cae83797c6
commit
29db256eba
@ -1,6 +1,8 @@
|
||||
Developing OnionShare
|
||||
=====================
|
||||
|
||||
.. _collaborating:
|
||||
|
||||
Collaborating
|
||||
-------------
|
||||
|
||||
@ -32,7 +34,7 @@ That file contains the technical instructions and commands necessary:
|
||||
Debugging Tips
|
||||
--------------
|
||||
|
||||
Verbose Mode
|
||||
Verbose mode
|
||||
^^^^^^^^^^^^
|
||||
|
||||
When developing, it's convenient to run OnionShare from a terminal and add the ``--verbose`` (or ``-v``) flag to the command. This will print a lot of helpful messages to the terminal such as when certain objects are initialized, when events occur (like buttons clicked, settings saved or reloaded), and other debug information. For example::
|
||||
@ -121,7 +123,7 @@ You can add your own debug messages by running the ``Common.log`` method from ``
|
||||
|
||||
This can be useful when learning the chain of events that occur when using the application or the value of certain variables before and after they are manipulated.
|
||||
|
||||
Local Only
|
||||
Local only
|
||||
^^^^^^^^^^
|
||||
|
||||
Tor is slow, and it's often convenient to skip starting onion services altogether during development. You can do this with the ``--local-only`` flag. For example::
|
||||
|
24
docs/source/help.rst
Normal file
24
docs/source/help.rst
Normal file
@ -0,0 +1,24 @@
|
||||
Getting Help
|
||||
============
|
||||
|
||||
If you need help with OnionShare, please follow the instructions below.
|
||||
|
||||
Read this website
|
||||
-----------------
|
||||
|
||||
This website is full of instructions on how to use OnionShare. Look through all of the sections first to see if it answers your questions.
|
||||
|
||||
Check the GitHub issues
|
||||
-----------------------
|
||||
|
||||
If you can't find a solution in this website, please check the `GitHub issues <https://github.com/micahflee/onionshare/issues>`_. It's possible that someone else has encountered the same problem and has either raised it with the developers, or maybe even posted a solution.
|
||||
|
||||
Submit an issue yourself
|
||||
------------------------
|
||||
|
||||
If you can't find a solution to your problem, or you wish to ask a question or suggest a new feature, please `submit an issue <https://github.com/micahflee/onionshare/issues/new>`_. This requires `creating an GitHub account <https://help.github.com/articles/signing-up-for-a-new-github-account/>`_.
|
||||
|
||||
Join our Keybase team
|
||||
---------------------
|
||||
|
||||
See :ref:`collaborating` for instructions on how to join our Keybase team that we use to discuss the project.
|
@ -24,5 +24,6 @@ Documentation
|
||||
|
||||
features
|
||||
advanced
|
||||
help
|
||||
security
|
||||
develop
|
||||
|
Loading…
Reference in New Issue
Block a user