mirror/weewx
1
0
Fork 0
mirror of https://github.com/weewx/weewx.git synced 2026-04-20 09:37:02 -04:00
Code Issues Packages Projects Releases Wiki Activity

make readme.htm match the docs.html of the web site

Browse Source
This commit is contained in:
matthewwall
2016-10-14 08:39:13 -04:00
parent afb5d7c1d0
commit f8da3ea695
1 changed files with 65 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

111
docs/readme.htm
View File

@@ -25,53 +25,72 @@ Version: 3.6.1
<div class="content">
<dl>
<dt><a href="usersguide.htm">User&#39;s Guide</a></dt>
<dd>
Contains complete details about how to install, configure, and
run <span class="code">weewx</span>. Includes instructions for
migrating from <span class="code">wview</span>, integrating
<span class="code">weewx</span> with a web server, uploading to
various weather services, and troubleshooting. This is the
definitive guide to using <span class="code">weewx</span>.
</dd>
<dt><a href="customizing.htm">Customization Guide</a></dt>
<dd>
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.
</dd>
<dl>
<dt><a href="apt-get.htm">Quick-Start</a></dt>
<dd>
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.
</dd>
<dt><a href="hardware.htm">Hardware Guide</a></dt>
<dd>
Includes capabilities and quirks of hardware that is directly
supported by <span class="code">weewx</span>. This guide
describes how to configure each type of hardware using the
<span class="code">wee_device</span> utility. It also includes
a driver compatibility table that shows which drivers work with
what hardware, and the capability level of each driver.
</dd>
<dt><a href="utilities.htm">Utilities Guide</a></dt>
<dd>
Explains how to use the <span class='code'>weewx</span>
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.
</dd>
<dt><a href="upgrading.htm">Upgrade Guide</a></dt>
<dd>Instructions for upgrading from previous versions of
<span class="code">weewx</span>. </dd>
<dt><a href="changes.txt">Change Log</a></dt>
<dd>List of the changes in each release.</dd>
</dl>
<dt><a href="usersguide.htm">User&#39;s Guide</a></dt>
<dd>
Contains complete details about how to install, configure, and
run <span class="code">weewx</span>. Includes instructions for
migrating from <span class="code">wview</span>, integrating
<span class="code">weewx</span> with a web server, uploading to
various weather services, and troubleshooting. This is the
definitive guide to using <span class="code">weewx</span>.
</dd>
<dt><a href="customizing.htm">Customization Guide</a></dt>
<dd>
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.
</dd>
<dt><a href="hardware.htm">Hardware Guide</a></dt>
<dd>
Includes capabilities and quirks of hardware that is directly
supported by <span class="code">weewx</span>. This guide
describes how to configure each type of hardware using the
<span class="code">wee_device</span> utility. It also includes
a driver compatibility table that shows which drivers work with
what hardware, and the capability level of each driver.
</dd>
<dt><a href="utilities.htm">Utilities Guide</a></dt>
<dd>
Reference for the various utilities that are included with
<span class="code">weewx</span>. 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.
</dd>
<dt><a href="upgrading.htm">Upgrade Guide</a></dt>
<dd>
Instructions for upgrading from previous versions of <span
class="code">weewx</span>.
</dd>
<dt><a href="changes.txt">Change Log</a></dt>
<dd>List of the changes in each release.</dd>
<dt><a href="http://weewx.com/hwcmp.html">Hardware Comparison</a></dt>
<dd>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.
</dd>
</dl>
</div>