The docs are still very WIP, but they should be functional. Just execute `make html` in the docs folder, and you should be able to navigate to `/docs/_build/html` and view it in your browser
37 lines
981 B
ReStructuredText
37 lines
981 B
ReStructuredText
.. highlight:: sh
|
|
.. _install:
|
|
|
|
Installation
|
|
============
|
|
|
|
Pip Install fbchat
|
|
------------------
|
|
|
|
To install fbchat, run this command::
|
|
|
|
$ pip install fbchat
|
|
|
|
If you don't have `pip <https://pip.pypa.io>`_ installed,
|
|
`this Python installation guide <http://docs.python-guide.org/en/latest/starting/installation/>`_
|
|
can guide you through the process.
|
|
|
|
Get the Source Code
|
|
-------------------
|
|
|
|
fbchat is developed on GitHub, where the code is
|
|
`always available <https://github.com/carpedm20/fbchat>`_.
|
|
|
|
You can either clone the public repository::
|
|
|
|
$ git clone git://github.com/carpedm20/fbchat.git
|
|
|
|
Or, download a `tarball <https://github.com/carpedm20/fbchat/tarball/master>`_::
|
|
|
|
$ curl -OL https://github.com/carpedm20/fbchat/tarball/master
|
|
# optionally, zipball is also available (for Windows users).
|
|
|
|
Once you have a copy of the source, you can embed it in your own Python
|
|
package, or install it into your site-packages easily::
|
|
|
|
$ python setup.py install
|