Browse Source

Hardware and platform documentation updates.

Neal Wilson 8 years ago
parent
commit
5e8b076f71

+ 6
- 2
docs/documentation/part1.html View File

@@ -21,7 +21,8 @@
21 21
 				</div>
22 22
 			</div>
23 23
 			<div id="maintext">
24
-				<h1>Part 1: Basic Setup and Use</h1>
24
+                            <h1>Part 1: Basic Setup and Use</h1>
25
+                            <div class="toc">
25 26
 				<ul>
26 27
 					<li><a href="platforms.html">Supported Platforms and Hardware</a></li>
27 28
 					<li><a href="requiredsoftware.html">Required Software</a></li>
@@ -43,10 +44,13 @@
43 44
 					</ul>
44 45
 					<li><a href="faq.html">Tips, Tricks, and Frequently Asked Questions</a></li>
45 46
 				</ul>
46
-				<p>This part of the documentation covers the things you should
47
+                            </div>
48
+                            <div class="ntoc">
49
+                                <p>This part of the documentation covers the things you should
47 50
 				know before starting to use Typica and the basics of getting
48 51
 				everything set up for use. Some of the topics are covered in
49 52
 				greater depth in Part 2.</p>
53
+                            </div>
50 54
 			</div>
51 55
 		</div>
52 56
 	</body>

+ 6
- 9
docs/documentation/platforms.html View File

@@ -29,12 +29,9 @@
29 29
 				<h2>Operating Systems</h2>
30 30
 				<p>Precompiled builds of Typica are provided for Microsoft
31 31
 				Windows and Mac OS X. The Microsoft Windows build has been
32
-				tested as working on both Windows 7 and Windows 8. It might
33
-				work on Windows XP or Windows Vista but this has not been
34
-				tested.</p>
35
-				<p>The Mac OS X build has been tested on Mac OS X 10.6 and 10.7.
36
-				It might work on 10.4, 10.5, and 10.8 but this has not been
37
-				tested. The build is also only for Macs with Intel processors.</p>
32
+				tested as working on both Windows 7 and Windows 10. It might
33
+				work on Windows XP, Windows Vista, or Windows 8 but this has not been tested.</p>
34
+				<p>The Mac OS X build has been tested on Mac OS X 10.6 through 10.11. The build is also only for Macs with Intel processors. Note that at the time of this writing National Instruments hardware is known to not work starting with OS X 10.10 or later. If National Instruments starts advertising that a newer version of NI DAQmx Base works with current operating system releases and supported hardware, Typica will probably work with that, but there's nothing that anybody else can do about that other than choosing different hardware.</p>
38 35
 				<p>Source code is provided which may be used to build Typica
39 36
 				on Linux, PowerPC based Macs, and possibly other platforms,
40 37
 				however instructions on doing this are beyond the scope of this
@@ -71,7 +68,7 @@
71 68
 				<a href="http://sine.ni.com/nips/cds/view/p/lang/en/nid/208177">NI USB-TC01</a>
72 69
 				is also an option on
73 70
 				this platform. This has been tested with
74
-				<a href="http://joule.ni.com/nidu/cds/view/p/id/3622/lang/en">NI-DAQmx 9.6.1</a>.
71
+				<a href="http://joule.ni.com/nidu/cds/view/p/id/3622/lang/en">NI-DAQmx 9.6.1</a>. A newer hardware revision has been released which no longer works with NI-DAQmx 9.6.1. If you encounter an error related to firmware being too new, try the latest version of NI-DAQmx.
75 72
 				Note that NI-DAQmx should not be installed at the same time as NI-DAQmx Base 3.6
76 73
 				however it is fine to have it installed at the same time as NI-DAQmx Base 2.2.</p>
77 74
 				<p>On all platforms, devices which communicate using the Modbus
@@ -101,13 +98,13 @@
101 98
 						<tr>
102 99
 							<th><a href="appendix-a.1.html">National Instruments NI USB-9211</a></th>
103 100
 							<td>yes</td>
104
-							<td>yes</td>
101
+							<td>only 10.9 or earlier</td>
105 102
 							<td>maybe</td>
106 103
 						</tr>
107 104
 						<tr>
108 105
 							<th><a href="appendix-a.2.html">National Instruments NI USB-9211A</a></th>
109 106
 							<td>yes</td>
110
-							<td>yes</td>
107
+							<td>only 10.9 or earlier</td>
111 108
 							<td>maybe</td>
112 109
 						</tr>
113 110
 						<tr>

+ 3
- 12
docs/documentation/requiredsoftware.html View File

@@ -46,18 +46,9 @@
46 46
 				There you can
47 47
 				<a href="http://www.postgresql.org/download/">download</a> the
48 48
 				appropriate binary package for the platform you intend to run
49
-				the database on. Typica has been tested with versions of
50
-				PostgreSQL up to 9.2, however the people behind PostgreSQL have
51
-				a very good history of making new versions better than the old
52
-				ones so the newest stable release is recommended for new
53
-				installations. When installing PostgreSQL, please make note of
49
+				the database on. Typica requires version 9.3 or later, however the people behind PostgreSQL have a very good history of making new versions better than the old one so the newest stable release is recommended for new installations. When installing PostgreSQL, please make note of
54 50
 				the password that you choose for the postgres user as you will
55
-				need this information later. Also ensure that PostgreSQL is set
56
-				up to run on port 5432. Aside from these details, the defaults
57
-				provided by the installer can be used so installation mainly
58
-				consists of running the installer that you download and
59
-				clicking the Next button several times until the installer is
60
-				finished.</p>
51
+				need this information later.</p>
61 52
 				
62 53
 				<p>If you do want to set up PostgreSQL for use over a network,
63 54
 				you may find
@@ -104,7 +95,7 @@
104 95
 				<h3>NI DAQmx Devices - Microsoft Windows Only</h3>
105 96
 				
106 97
 				<p>Certain hardware from National Instruments requires
107
-				NI-DAQmx. Typica has been tested with version 9.6.1. See
98
+				NI-DAQmx. Typica has been tested with version 9.6.1, however newer hardware revisions of some supported hardware requires a newer version. See
108 99
 				<a href="platforms.html#hardware">Supported Platforms and Hardware</a>
109 100
 				for more details.</p>
110 101
 				

+ 2
- 1
docs/style.css View File

@@ -88,4 +88,5 @@ h2 {
88 88
 }
89 89
 li {
90 90
 	list-style-type: none;
91
-}
91
+}
92
+

Loading…
Cancel
Save