sergey/hosts
1
0
Fork 0
mirror of https://github.com/StevenBlack/hosts.git synced 2026-07-01 02:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update the docs, remove the shallow clone proscription.

Browse Source
This commit is contained in:
Steven Black
2017-08-20 12:18:05 -04:00
parent 8b08fd73b5
commit db70e34166
1 changed files with 8 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
readme_template.md
View File

@@ -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