| 
									
										
										
										
											2015-04-29 11:33:31 +00:00
										 |  |  | This folder  contains the sources  of WSJT-X documentation.   To build | 
					
						
							| 
									
										
										
										
											2015-11-19 00:08:30 +00:00
										 |  |  | these you will need the asciidoctor tool installed. | 
					
						
							| 
									
										
										
										
											2015-04-29 11:33:31 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | If you do not wish to build  the documentation, it is possible to skip | 
					
						
							|  |  |  | this  directory  in the  WSJT-X  build  by  setting the  CMake  option | 
					
						
							|  |  |  | WSJT_GENERATE_DOCS to OFF in your build tree. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | On Linux | 
					
						
							|  |  |  | ======== | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | You will probably have these installed already if you are building the | 
					
						
							|  |  |  | WSJT-X  manpages,  if you  are  not  you  will  just need  to  install | 
					
						
							|  |  |  | asciidoc: | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-19 00:08:30 +00:00
										 |  |  |  sudo apt-get install asciidoctor | 
					
						
							| 
									
										
										
										
											2015-04-29 11:33:31 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | or | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-19 00:08:30 +00:00
										 |  |  |  sudo yum install asciidoctor | 
					
						
							| 
									
										
										
										
											2015-04-29 11:33:31 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | or whatever your distribution and package management requires. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | On Mac OS X | 
					
						
							|  |  |  | =========== | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | I recommend MacPorts: | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-19 00:08:30 +00:00
										 |  |  |  sudo port install rb-rubygems | 
					
						
							|  |  |  |  sudo gem install asciidoctor | 
					
						
							| 
									
										
										
										
											2015-04-29 11:33:31 +00:00
										 |  |  | 
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | On Windows | 
					
						
							|  |  |  | ========== | 
					
						
							|  |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-19 00:08:30 +00:00
										 |  |  | The asciidoctor  tool is a  Ruby script so you  will need to  install a | 
					
						
							|  |  |  | version of Ruby. The gem tool is a good way to install asciidoctor: | 
					
						
							| 
									
										
										
										
											2015-04-29 11:33:31 +00:00
										 |  |  | 
 | 
					
						
							| 
									
										
										
										
											2015-11-19 00:08:30 +00:00
										 |  |  |    gem install asciidoctor |