[caffe-contrib] 341/362: README.Debian: trivial update

[Zhou Mo]

This is an automated email from the git hooks/post-receive script.

cdluminate-guest pushed a commit to branch master
in repository caffe-contrib.

commit 5f5d5206429a0b99160c01bd782f016f572762f7
Author: Zhou Mo <cdluminate at gmail.com>
Date:   Sat Apr 16 02:28:44 2016 +0000

    README.Debian: trivial update
---
 debian/README.Debian | 67 ++++++++++++++++++++++++++++++----------------------
 1 file changed, 39 insertions(+), 28 deletions(-)

diff --git a/debian/README.Debian b/debian/README.Debian
index 9c70564..9094c05 100644
--- a/debian/README.Debian
+++ b/debian/README.Debian
@@ -4,14 +4,14 @@
  In short, package "Caffe" for Debian is compiled as 2 sets of packages,
  but the two sets are not co-installable. [1]
 
-  * Caffe-CPU: (configured as CPU_ONLY)
+  + Caffe-CPU: (configured as CPU_ONLY)
 
     * caffe-cpu          -- command line utilities
-	* libcaffe-cpu*      -- core library
-	* libcaffe-cpu-dev   -- development files
-	* python-caffe-cpu   -- python2 interface
+    * libcaffe-cpu*      -- core library
+    * libcaffe-cpu-dev   -- development files
+    * python-caffe-cpu   -- python2 interface
  
-  * Caffe-CUDA: (compiled with CUDA)
+  + Caffe-CUDA: (compiled with CUDA)
 
     * caffe-cuda
     * libcaffe-cuda*
@@ -33,58 +33,66 @@
 
   * custom-cpu
   * custom-cuda
-  (see debian/rules for detail)
 
- Instructions for doing local custom build:
+ Following is instruction for doing such a custom build:
 
   1. Install Build-Dependencies, including Debian packaging utils.
 
      * Packaging helpers:
 
-       $ apt install build-essential debhelper devscripts
+        $ apt install build-essential debhelper devscripts
 
      * Build-Dependencies:
 
-       $ apt-get build-dep caffe
+        $ apt-get build-dep caffe
 
-	   Or install build-dependencies manually, the dependency information
-       is stored at `debian/control`.
+    Or install build-dependencies manually, the dependency information
+    is stored at the top part of `debian/control`.
 
-  2. [Can omit this] Read the configuration template at the top part of
-     debian/rules, then have a look at the bottom part of this file. Tweak
-     some options as long as you need. (note that debian/rules is a Makefile)
+  2. [Optional] Read the configuration template at the top part of
+     debian/rules, then have a look at the bottom part of this file. 
+     Tweak some options as long as you need. (`debian/rules` is a Makefile)
      Here are some hints:
 
      * CUSTOM_JOBS   := "-j5"
+
        Parallel compiling jobs, i.e. make -j5
 
      * CONFFLAG_CPU_CUSTOM = ...
+
        Tweak this when you like to compile the caffe-cpu set,
        and this variable stores cmake options.
 
      * CONFFLAG_CUDA_CUSTOM = ...
+
        Tweak this when you like to compile the caffe-cuda set,
        and this variable stores cmake options.
 
-  3. Start compiling. (make sure you are in the root of source tree)
+  3. Choose a configuration and start compiling.
+     (make sure you are in the root of source tree)
+
+     To compile caffe-cpu set:
 
-     Compiling caffe-cpu set:
        $ debian/rules custom-cpu
 
-     Compiling caffe-cuda set:
+     To compile caffe-cuda set:
+
        $ debian/rules custom-cuda
 
-     The default custom configuration is tested, however there's no
-     promise that the custom build will not fail.
+     The default custom configuration is tested by me, however
+     there's no promise that the custom build will always work.
+     Suggestion is welcome :-)
+
+  4. Installing freshly cooked Caffe Packages
+
+     * Check the resulting packages
 
-  4. Installing fresh Caffe Package
+        $ ls ../*.deb
 
-     * check the resulting packages
-       $ ls	../*.deb
+     * If nothing went wrong, install them. [2]
 
-     If nothing went wrong, install them. [2]
-	   $ sudo dpkg -i libcaffe-*.deb
-       $ sudo dpkg -i <others>
+        $ sudo dpkg -i libcaffe-*.deb
+        $ sudo dpkg -i <others>
 
   5. Grab some datasets, set up your network and have fun.
 
@@ -99,7 +107,9 @@
 
      $ caffe time -model examples/mnist/lenet.prototxt -gpu 0
 
-   Well, this way (using deploy version of network) requires no dataset.
+   Well, testing caffe in this way (using deploy version of network)
+   requires no dataset, which may be useful for some maintainers
+   who are not familiar with Caffe.
 
                    Footnotes
                    =========
@@ -109,7 +119,8 @@
 
 [2] Make sure to firstly install libcaffe-* which includes libcaffe.so.*,
     the shared object file of caffe, or you will get some error messages
-	from dpkg (dependency unsatisfied).
+    from dpkg (dependency unsatisfied). However that would NOT be hurt
+    if you didn't follow.
 
 [A]
- -- Zhou Mo <cdluminate at gmail.com>  Sun, 27 Mar 2016 00:00:00 +0000
+ -- Zhou Mo <cdluminate at gmail.com>  Sun, 16 Apr 2016 00:00:00 +0000

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/caffe-contrib.git