From db70e34166b57e186d44f0246164e659428b5588 Mon Sep 17 00:00:00 2001 From: Steven Black Date: Sun, 20 Aug 2017 12:18:05 -0400 Subject: [PATCH] Update the docs, remove the shallow clone proscription. --- readme_template.md | 26 ++++++++------------------ 1 file changed, 8 insertions(+), 18 deletions(-) diff --git a/readme_template.md b/readme_template.md index 2bcddd7f4..3584f5d09 100644 --- a/readme_template.md +++ b/readme_template.md @@ -1,23 +1,5 @@ [![Build Status](https://travis-ci.org/StevenBlack/hosts.svg?branch=master)](https://travis-ci.org/StevenBlack/hosts) -### Cloning? Use a shallow clone and avoid 400 Mb of history - -A **shallow clone** is a good idea because you probably don't need many years of history. - -Like this: - - git clone --depth 5 https://github.com/StevenBlack/hosts.git - -To run unit tests, in the top level directory, just run: - - python testUpdateHostsFile.py - -**Note** if you are using Python 2, you must first install the `mock` library: - - pip install mock - -Afterwards, you can follow the instructions above. - # Unified hosts file @EXTENSIONS_HEADER@ This repository consolidates several reputable `hosts` files, and merges them @@ -57,6 +39,14 @@ folders. ## Generate your own unified hosts file +To run unit tests, in the top level directory, just run: + + python testUpdateHostsFile.py + +**Note** if you are using Python 2, you must first install the `mock` library: + + pip install mock + The `updateHostsFile.py` script, which is python 2.7 and Python 3-compatible, will generate a unified hosts file based on the sources in the local `data/` subfolder. The script will prompt you Whether it should fetch updated