lavatech/rana-cli
2
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

format rst so pypi can render it

Browse source
This commit is contained in:
Alan Hamlett 2015-08-11 10:38:01 -07:00
parent c81f7e382c
commit a2b0978795
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.rst
View file

@ -25,6 +25,7 @@ Options can be passed via command line, or set in the ``$HOME/.wakatime.cfg``
config file. Command line arguments take precedence over config file settings. config file. Command line arguments take precedence over config file settings.
The ``$HOME/.wakatime.cfg`` file is in `INI <http://en.wikipedia.org/wiki/INI_file>`_ The ``$HOME/.wakatime.cfg`` file is in `INI <http://en.wikipedia.org/wiki/INI_file>`_
format. An example config file looks like:: format. An example config file looks like::
[settings] [settings]
debug = false debug = false
api_key = your-api-key api_key = your-api-key
@ -45,15 +46,16 @@ Installation
Each `plugin <https://wakatime.com/plugins>`_ should install wakatime for you, except for the `Emacs WakaTime plugin <https://github.com/wakatime/wakatime-mode>`_. Each `plugin <https://wakatime.com/plugins>`_ should install wakatime for you, except for the `Emacs WakaTime plugin <https://github.com/wakatime/wakatime-mode>`_.
If your plugin does not install wakatime cli(this package), install it with:: If your plugin does not install wakatime cli(this package), install it with::
pip install wakatime pip install wakatime
Troubleshooting Troubleshooting
--------------- ---------------
WakaTime CLI writes errors to a common log file in your User ``$HOME`` directory: WakaTime CLI writes errors to a common log file in your User ``$HOME`` directory::
``~/.wakatime.log`` ~/.wakatime.log
Set ``debug=true`` in ``~/.wakatime.cfg`` for more verbose logging, but don't forget to set it back to ``debug=false`` afterwards or your editor might be laggy while waiting for wakatime cli to finish executing. Set ``debug=true`` in ``~/.wakatime.cfg`` for more verbose logging, but don't forget to set it back to ``debug=false`` afterwards or your editor might be laggy while waiting for wakatime cli to finish executing.
@ -79,9 +81,7 @@ Check that heartbeats are received by the WakaTime api with the ``last_heartbeat
Contributing Contributing
------------ ------------
Before contributing a pull request, make sure tests pass: Before contributing a pull request, make sure tests pass::
.. code-block::
virtualenv venv virtualenv venv
. venv/bin/activate . venv/bin/activate