]> git.ipfire.org Git - thirdparty/squid.git/commitdiff
Fixed, changed addresses in README. Made README look better on Github.
authorAlex Rousskov <rousskov@measurement-factory.com>
Sun, 6 Aug 2017 00:20:40 +0000 (18:20 -0600)
committerAmos Jeffries <yadij@users.noreply.github.com>
Sun, 26 Nov 2017 10:17:10 +0000 (23:17 +1300)
Why not add README.md? Not enough reasons to warrant info duplication:
Markdown is not particularly helpful for rendering a trivial list of
references, and Github already renders HTTP links appropriately.

Why not move README to README.md? Many tools and console humans still
look for README rather than README.md.

Why not use Markdown in README? Github does not render such markup.

TODO: Consider removing detailed distribution terms at the bottom
because "everybody" knows what GPLv2 basically means, and we already
tell the reader where to find the exact licensing terms.

README

diff --git a/README b/README
index ba6ac4aea7ea4a07f70db40044061106c0dccd22..171a0b637a8b6d2a0773cee9744328d13c6d997a 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,5 @@
-
-SQUID Web Proxy Cache                         http://www.squid-cache.org/
--------------------------------------------------------------------------
+SQUID Web Proxy Cache                        http://www.squid-cache.org/
+------------------------------------------------------------------------
 
 Copyright (C) 1996-2017 The Squid Software Foundation and contributors
 
@@ -8,22 +7,28 @@ Squid software is distributed under GPLv2+ license and includes
 contributions from numerous individuals and organizations.
 Please see the COPYING and CONTRIBUTORS files for details.
 
-  This program is free software; you can redistribute it and/or modify
-  it under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
-  (at your option) any later version.
-  
-  This program is distributed in the hope that it will be useful,
-  but WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-  GNU General Public License for more details.
-  
-  You should have received a copy of the GNU General Public License
-  along with this program. If not, see http://www.gnu.org/licenses/.
-
-Please use our mailing lists for questions, feedback and bug fixes:
-
-        squid-users@squid-cache.org    # general questions, public forum
-        squid-bugs@squid-cache.org     # bugs and fixes
-        squid@squid-cache.org          # other feedback
 
+For support, please use the following resources:
+
+    * General help and support:  squid-users@lists.squid-cache.org
+    * Public bug reports:        http://bugs.squid-cache.org/
+    * Security bug reports:      squid-bugs@lists.squid-cache.org
+    * Development discussions:   squid-dev@lists.squid-cache.org
+
+For mailing list subscription instructions, project maintainers contact
+information, commercial services, and many other support details, please
+visit http://www.squid-cache.org/Support/
+
+
+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program. If not, see http://www.gnu.org/licenses/.