From f8da3ea69598b71a983d684de748e39b79dd7b8d Mon Sep 17 00:00:00 2001 From: matthewwall Date: Fri, 14 Oct 2016 08:39:13 -0400 Subject: [PATCH] make readme.htm match the docs.html of the web site --- docs/readme.htm | 111 ++++++++++++++++++++++++++++-------------------- 1 file changed, 65 insertions(+), 46 deletions(-) diff --git a/docs/readme.htm b/docs/readme.htm index 7b5ae8aa..f84a7acd 100644 --- a/docs/readme.htm +++ b/docs/readme.htm @@ -25,53 +25,72 @@ Version: 3.6.1
-
-
User's Guide
-
- Contains complete details about how to install, configure, and - run weewx. Includes instructions for - migrating from wview, integrating - weewx with a web server, uploading to - various weather services, and troubleshooting. This is the - definitive guide to using weewx. -
- -
Customization Guide
-
- Describes how to modify reports through configuration - options as well and templates. Explains how to create and - customize skins. Also includes more advanced topics such as - creating custom generators and services, customizing the - internal engine, and creating drivers for new weather station - types. -
+
+
Quick-Start
+
+ If you use a Debian-based system, such as Ubuntu, Mint, or + Raspian, then you may want to follow this "quick start" guide. + It will help you do a basic install to get you started, which + you can then refine. Alternatively, you can follow the more + complete directions in the User's Guide. +
-
Hardware Guide
-
- Includes capabilities and quirks of hardware that is directly - supported by weewx. This guide - describes how to configure each type of hardware using the - wee_device utility. It also includes - a driver compatibility table that shows which drivers work with - what hardware, and the capability level of each driver. -
- -
Utilities Guide
-
- Explains how to use the weewx - utilities and provides additional details beyond the standard - command-line help options. Includes instructions for manipulating - the database, changing drivers, modifying common configuration options, - installing and removing extensions, and importing data. -
- -
Upgrade Guide
-
Instructions for upgrading from previous versions of - weewx.
- -
Change Log
-
List of the changes in each release.
-
+
User's Guide
+
+ Contains complete details about how to install, configure, and + run weewx. Includes instructions for + migrating from wview, integrating + weewx with a web server, uploading to + various weather services, and troubleshooting. This is the + definitive guide to using weewx. +
+ +
Customization Guide
+
+ Describes how to modify reports through configuration + options and templates. Explains how to create and + customize skins. Also includes more advanced topics such as + creating custom generators and services, adding new template + tags, and creating drivers for new weather station hardware. +
+ +
Hardware Guide
+
+ Includes capabilities and quirks of hardware that is directly + supported by weewx. This guide + describes how to configure each type of hardware using the + wee_device utility. It also includes + a driver compatibility table that shows which drivers work with + what hardware, and the capability level of each driver. +
+ +
Utilities Guide
+
+ Reference for the various utilities that are included with + weewx. This guide contains details + about the options for each utility, as well of examples of how + to use the utilities. The programs include an import utility, + a database utility, a tool to configure weather station + hardware, and a tool to upload missing data to + Weather Underground. +
+ +
Upgrade Guide
+
+ Instructions for upgrading from previous versions of weewx. +
+ +
Change Log
+
List of the changes in each release.
+ +
Hardware Comparison
+
Are you looking for a weather station? Are you considering + building your own station? This table lists the sensors, + configurations, and specifications for various + types of weather-related hardware. +
+