Marown/hosts
1
0
Fork 0
mirror of https://github.com/StevenBlack/hosts.git synced 2024-06-28 16:45:46 +02:00
Code Issues Packages Projects Releases Wiki Activity

Gentle edits to the readme template.

Browse Source
This commit is contained in:
Steven Black 2021-07-29 13:51:03 -04:00
parent 47a4b23351
commit 16f297b992
No known key found for this signature in database
GPG Key ID: 8B814B914974E6AF
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
readme_template.md
View File

@ -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 <whitelistfile>`, or `-w <whitelistfile>`: 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.