diff --git a/readme_template.md b/readme_template.md index 4c370d415..a4e2b1802 100644 --- a/readme_template.md +++ b/readme_template.md @@ -79,7 +79,7 @@ Access the terminal like this: docker run -it (containerid) bash ``` -### Option 2: Generate it in your own environment. +### Option 2: Generate it in your own environment To generate your own amalgamated hosts files you will need Python 3.5 or later. @@ -91,7 +91,7 @@ pip3 install --user -r requirements.txt **Note** we recommend the `--user` flag which installs the required dependencies at the user level. More information about it can be found on pip [documentation](https://pip.pypa.io/en/stable/reference/pip_install/?highlight=--user#cmdoption-user). -### Common steps regardless of your development environment. +### Common steps regardless of your development environment To **run unit tests**, in the top-level directory, run: @@ -108,7 +108,7 @@ will use the `hosts` file that's already there. python3 updateHostsFile.py [--auto] [--replace] [--ip nnn.nnn.nnn.nnn] [--extensions ext1 ext2 ext3] ``` -#### Command line options: +#### Command line options `--help`, or `-h`: display help. @@ -169,7 +169,7 @@ in hosts format to the generated hosts file. `--whitelist `, or `-w `: Use the given whitelist file to remove hosts from the generated hosts file. -#### Using NixOS: +#### Using NixOS To install hosts file on your machine add the following into your `configuration.nix`: @@ -328,7 +328,7 @@ To open a command prompt as administrator in the repository's directory, do the You can also refer to the "Third-Party Hosts Managers" section for further recommended solutions from third parties. -### Warning: Using this `hosts` file in Windows may require disabling DNS Cache service. +### Warning: Using this `hosts` file in Windows may require disabling DNS Cache service Windows has issues with larger hosts files. Recent changes in security within Windows 10 denies access to changing services via other tools except registry hacks. Use the `disable-dnscache-service-win.cmd` @@ -447,7 +447,7 @@ devices under a variety of operating systems. * [BlackHosts - Command Line Installer/Updater](https://github.com/Lateralus138/blackhosts) This is a cross-platform command line utility to help install/update hosts files found at this repository. -## Contribute! +## Contribute Please read our [Contributing Guide](https://github.com/StevenBlack/hosts/blob/master/contributing.md). Among other things, this explains how we organize files and folders in this repository.