Draft proposal for README changes

Addresses issue #829, but also addresses other commonly out-of-scope issues that arise.
This commit is contained in:
ScriptTiger 2020-02-24 23:24:44 +08:00 committed by GitHub
parent dc51c546be
commit 6fae74b406
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,8 @@
----
**Take Note!** This version of the Hosts file generator, and tests, are for Python 3.5+ only.
**Take Note!**
- This version of the Hosts file generator, and tests, are for Python 3.5+ only.
- This repository centers around the hosts file aggregation Python script and NOT around the hosts files it produces. Issues regarding the personal management of hosts files, such as hosts file managers, are out of scope. However, as a courtesy, there are some recommended hosts manager options available.
- With the exception of issues and PRs regarding changes to `hosts/data/StevenBlack/hosts`, all other issues regarding the content of the produced hosts files should be made with the appropriate data source that contributed the content in question. The contact information for all of the data sources can be found in the `hosts/data/` directory.
----
![readme](https://user-images.githubusercontent.com/36028424/40330477-9df2c2e0-5d7f-11e8-8ac8-511d719a5eae.png)
@ -255,6 +257,8 @@ Gentoo users may find [`sb-hosts`](https://github.com/PF4Public/gentoo-overlay/t
## Updating hosts file on Windows
(NOTE: If you love the hosts files produced by this repository but are only interested in managing the hosts files you actually use on Windows and not actually utilizing the full functionality of the awesome script that is the core of this repository, please see the below `Third-Party Hosts Managers` section for hosts manager solutions, such as [Unified Hosts AutoUpdate](https://github.com/ScriptTiger/Unified-Hosts-AutoUpdate "Unified Hosts AutoUpdate").)
On Linux and Mac OS X, run the Python script. On Windows more
work is required due to compatibility issues so it's preferable to run the batch file as follows: