update changelog and installation instructions to clone with --depth 1

CPJKU · Mar 9, 2016 · fce5473 · fce5473
1 parent 65b28b9
commit fce5473
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 8 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,10 @@ Release Notes
 Version 0.14.dev
 ----------------
 
+API relevant changes:
+
+* Refactored the `ml.rnn` to `ml.nn` and converted the models to pickles (#110)
+
 Version 0.13 (release date: 2016-03-07)
 ---------------------------------------
 

diff --git a/README.rst b/README.rst
@@ -112,18 +112,19 @@ Install from source
 
 If you plan to use the package as a developer, clone the Git repository::
 
-    git clone --recursive https://github.com/CPJKU/madmom.git
+    git clone --recursive --depth 1 https://github.com/CPJKU/madmom.git
 
 Since the pre-trained model/data files are not included in this repository but
 rather added as a Git submodule, you either have to clone the repo recursively.
 This is equivalent to these steps::
 
     git clone  https://github.com/CPJKU/madmom.git
     cd madmom
-    git submodule update --init --remote
+    git submodule update --init --remote --depth 1
 
-You can then either include the package directory in your ``$PYTHONPATH`` and
-compile the Cython extensions with::
+To obtain the full history, omit the `--depth 1` part. You can then either
+include the package directory in your ``$PYTHONPATH`` and compile the Cython
+extensions with::
 
     python setup.py build_ext --inplace
 

diff --git a/docs/installation.rst b/docs/installation.rst
@@ -69,18 +69,19 @@ Install from source
 
 If you plan to use the package as a developer, clone the Git repository::
 
-  git clone --recursive https://github.com/CPJKU/madmom.git
+  git clone --recursive --depth 1 https://github.com/CPJKU/madmom.git
 
 Since the pre-trained model/data files are not included in this repository but
 rather added as a Git submodule, you either have to clone the repo recursively.
 This is equivalent to these steps::
 
   git clone  https://github.com/CPJKU/madmom.git
   cd madmom
-  git submodule update --init --remote
+  git submodule update --init --remote --depth 1
 
-You can then either include the package directory in your ``$PYTHONPATH`` and
-compile the Cython extensions with::
+To obtain the full history, omit the `--depth 1` part. You can then either
+include the package directory in your ``$PYTHONPATH`` and compile the Cython
+extensions with::
 
   python setup.py build_ext --inplace