Skip to content

Commit

Permalink
Added README file
Browse files Browse the repository at this point in the history
  • Loading branch information
macagua committed Sep 29, 2018
1 parent 2b22f0b commit 68d3d3f
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
Plone theming suite
====================

This is the `Plone theming suite <https://github.com/plone-ve/plonethemes.suite>`_ documentation repository.


Documentation installation
--------------------------

To get a local documentation copy follow the steps below: ::

$ cd plonethemes.suite
$ source ./bin/activate
$ pip install -r requirements_docs.txt
$ cd docs && make clean html
$ firefox _build/html/index.html

**Note:**

More information check out the suite full documentation http://plone-theming-suite.readthedocs.io/.


Support
=======

If you run into any issues trying to get this to work, please, add an
issue to the `tracker here`_ on this github project.


Collaborations
==============

Really thanks to:


Original Author
----------------

* Leonardo J .Caballero G. aka macagua


Impressive collaborations
-------------------------

* Full name aka username

For an updated list of all contributors visit the following URL:
https://github.com/plone-ve/plonethemes.docs/graphs/contributors

.. _tracker here: https://github.com/plone-ve/plonethemes.docs/issues

0 comments on commit 68d3d3f

Please sign in to comment.