Auto-commit for docs

COPYRIGHT.txt

@@ -18,6 +18,5 @@ General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with python-openzwave. If not, see http://www.gnu.org/licenses.
 
-author: bibi21000 <[email protected]>
-author: maarten damen
-license: GPL(v3)
+author: bibi21000 <[email protected]> author: maarten damen license:
+GPL(v3)

DEVEL.txt

@@ -3,65 +3,41 @@ Developpers information
 ***********************
 
 
-How to develop patches
-======================
+How to develop for python-openzwave
+===================================
 
 Get the sources
 
-   hg clone https://code.google.com/p/python-openzwave/
+   git clone https://github.com/bibi21000/python-openzwave
 
-Developp, test, debug, test, ... :)
+You must now install python-openzwave in develop mode
 
-When your modification is functional, you are ready to submit a patch
+   make develop
 
-Sync your repository :
+Your password will be asked (by sudo) for installing eggs in your
+local directory.
 
-   hg pull https://code.google.com/p/python-openzwave/
+Develop, test, debug, test, ... :)
 
-   hg update
+Update the documentation if needed. You surely found the documentation
+useful, so please keep it up to date
 
-Generate the patch
+You can create an account on travis to run the (futurs) tests.
 
-   hg diff > somewordstoexplainwhatthepatchdoes.patch
-
-As the code of python-openzwave is under developpment, submit atomic
-patches. Otherwise, you should have merge problems when syncing your
-repository.
-
-This will generate a file in the current directory. Finally post it on
-issues projets : https://code.google.com/p/python-
-openzwave/issues/list .
-
-
-Using a developper account
-==========================
-
-Contact the developpers for more informations.
+At last but not least, submit your request
 
 
 Documentation
 =============
 
 Documentation is managed with sphinx. Don't utpdate txt files (README,
-INSTALL, ...) , update the sources (>>*<<.rst) in docs. Use the
-following commands to generate all docs files (txt, html and joomla)
-
-   ./make_docs.sh
-
+INSTALL, ...), update the RST sources in docs. Use the following
+commands to generate all docs files (txt, html and joomla)
 
-Packagers
-=========
+You need to have installed python-openzave (in either develop or
+install mode) before generating the documentation.
 
-If you want to package python-openzwave for your distribution, look at
-the make_dist.sh script. It builds a distribution directory with
-documentation in build/distdir.
-
-You can also submit your script in issues, it will be added to the
-main code.
-
-On Debian/ubuntu you can build python-openzwave using :
-
-   dpkg-builpackage
+   make docs
 
 
 Static vs dynamic (or shared)
@@ -73,20 +49,17 @@ MUST have only one instance of the manager running on your computer.
 There is 2 ways of linking libraries with a program :
 
    * static : includes a copy of the library in your binary program.
-     This means
-
-   that your program has its own instance of the library. This the way
-   the install.sh runs. So you CAN'T have another program (like the
-   control-panel) running when using the python-openzwave library
+     This means that your program has its own instance of the library.
+     This the way the install.sh runs. So you CAN'T have another
+     program (like the control-panel) running when using the python-
+     openzwave library
 
    * dynamic or shared : includes a link to the library in your
-     binary program.
-
-   This means that your program share the library with other programs.
-   In this case, the instance is owned directly by the library. This
-   the way the debian package works. So you CAN have another program
-   running when using the python-openzwave library. Of course, this
-   program MUST use the shared library.
+     binary program. This means that your program share the library
+     with other programs. In this case, the instance is owned directly
+     by the library. This the way the debian package works. So you CAN
+     have another program running when using the python-openzwave
+     library. Of course, this program MUST use the shared library too.
 
 
 Migrate from py-openzwave to python-openzwave
@@ -109,8 +82,7 @@ Update your code :
 
 Everywhere in your code replace :
 
-   "import openzwave" to "import libopenzwave" "from openzwave" to
-   "from libopenzwave"
+      "import openzwave" to "import libopenzwave" "from openzwave" to "from libopenzwave"
 
 notifications :
 
@@ -121,12 +93,6 @@ openzwave, it's a value of the right type :
 
    'value' : getValueFromType(manager,v.GetId?()),
 
-wrapper : The wrapper is no longer supported. Now high level acces to
-ZWave network is provided by the API (work in progress)
-
-
-History
-=======
+wrapper : The wrapper is no longer supported.
 
-The original script was from maarten damen :
-https://github.com/maartendamen/python-openzwave
+Now high level acces to ZWave network is provided by the API

INSTALL_ARCH.txt

@@ -7,23 +7,12 @@ Install the needed tools
 ========================
 
 You must install git and other tools to get sources of python-
-openzwave and openzwave. Look at the documentation of your Linux
-distribution to do that.
-
-   sudo apt-get install python-pip python-dev cython
-
-You also need some python modules, on a debian like distribution :
-
-   sudo apt-get install python-dev python-setuptools python-louie
-
-To compile the openzwave library, you need the common builds tools and
-the libudev developments headers.
+openzwave and openzwave and build them. Look at the documentation of
+your Linux distribution to do that.
 
 On a debian like distribution :
 
-   sudo apt-get install build-essential libudev-dev g++ make
-
-TO DO python 3
+   sudo make deps
 
 
 Get archive of python-openzwave
@@ -49,22 +38,23 @@ Go to the previously created directory :
 
 Now, you can compile sources :
 
-   ./compile.sh
+   make build
 
 Or if you have already build python-openzwave in a previous
 installation, you can use the clean option to remove old builds.
 
-   ./compile.sh clean
+   make clean
+   make build
 
 
 Installation
 ============
 
 You can now install the packages using the following command will.
 
-   sudo ./install.sh
+   sudo make install
 
 The installation script create a list of installed files. So you can
 remove python-openzwave using the following command :
 
-   sudo ./uninstall.sh
+   sudo make uninstall

INSTALL_MAN.txt

@@ -10,21 +10,15 @@ Install the needed tools
 ========================
 
 You must install git and other tools to get sources of python-
-openzwave and openzwave. Look at the documentation of your Linux
-distribution to do that.
+openzwave and openzwave and build them. Look at the documentation of
+your Linux distribution to do that.
 
 On a debian like distribution :
 
-   sudo apt-get install git python-pip python-dev cython
-
-You also need some python modules, on a debian like distribution :
-
-   sudo apt-get install python-dev python-setuptools python-louie
+   sudo make deps
 
 You need sphinx and make to generate the documentation.
 
-TODO : installation for python 3
-
 On a debian like distribution :
 
    sudo apt-get install python-sphinx make
@@ -34,13 +28,6 @@ You also need to install some sphinx contributions :
    sudo pip install sphinxcontrib-blockdiag sphinxcontrib-actdiag
    sudo pip install sphinxcontrib-nwdiag sphinxcontrib-seqdiag
 
-To compile the openzwave library, you need the common builds tools and
-the libudev developments headers.
-
-On a debian like distribution :
-
-   sudo apt-get install build-essential libudev-dev g++
-
 
 Get sources of python-openzwave and open-zwave
 ==============================================

INSTALL_REPO.txt

@@ -7,18 +7,12 @@ Install the needed tools
 ========================
 
 You must install git and other tools to get sources of python-
-openzwave and openzwave. Look at the documentation of your Linux
-distribution to do that.
+openzwave and openzwave and build them. Look at the documentation of
+your Linux distribution to do that.
 
 On a debian like distribution :
 
-   sudo apt-get install git python-dev cython python-pip
-
-You also need some python modules, on a debian like distribution :
-
-   sudo apt-get install python-dev python-setuptools python-louie
-
-TODO : installation for python 3
+   sudo make deps
 
 You need sphinx and make to generate the documentation.
 

README.md

@@ -0,0 +1,39 @@
+
+python-openzwave
+****************
+
+This is the new generation of python-openzwave.
+
+python-openzwave is a python wrapper for the openzwave library. It's
+also contains an api (object representation of Zwave network) and
+ozwsh (using the api).
+
+You can install python-openzwave in 3 ways :
+
+   * From repository : you need to install mercurial, subversion and
+     the common builds tools. Look at INSTALL_REPO to do such
+     installation
+
+   * From an archive : you don't need to install mercurial,
+     subversion. Only the common builds tools are needed. Look at
+     INSTALL_ARCH to do such installation
+
+   * From scratch : if you can't build python-openzwave
+     automatically or you are using windows or MacOS X. Look at
+     INSTALL_MAN to do such installation
+
+Testing python-openzwave :
+
+You don't need to install python-openzwave to test it. Look at
+EXAMPLES.
+
+
+To do
+=====
+
+* Makefile : full process projet management
+
+* Improve tests : add virtual nodes and controllers to pass test on
+  travis
+
+* ...

docs/COPYRIGHT.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 This file is part of python-openzwave project https://github.com/bibi21000/python-openzwave.
 
 License