Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@rparkins999
rparkins999 committed Jan 6, 2024
1 parent a850258 commit 081a514
Show file tree
Hide file tree
Showing 19 changed files with 1,609 additions and 613 deletions.
154 changes: 130 additions & 24 deletions Sqliteman/sqliteman/doc/en/Compilation.html
View file
Original file line number Diff line number Diff line change
@@ -1,24 +1,130 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Compilation and Installation</title><link rel="stylesheet" href="kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.67.2"><meta name="keywords" content="Sqliteman, SQL, Sqlite, development, database"><link rel="start" href="index.html" title="The Sqliteman Handbook"><link rel="up" href="Installation.html" title="Appendix A. Installation"><link rel="prev" href="Requirements.html" title="Requirements"><link rel="next" href="Configuration.html" title="Configuration"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Compilation and Installation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Requirements.html">Prev</a> </td><th width="60%" align="center">Appendix A. Installation</th><td width="20%" align="right"> <a accesskey="n" href="Configuration.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="compilation"></a>Compilation and Installation</h2></div></div></div><p>Some more tools are required for compiling <span class="application">Sqliteman</span>
from source code:</p><p>
</p>
<div class="itemizedlist">
<ul type="disc">
<li><p><a href="http://cmake.org" target="_top">Cmake</a> build system</p></li>
<li><p><a href="https://www.qt.io/download-open-source/">Qt5</a>
library with its development parts (headers etc.)<br>
(sqliteman versions before will build with Qt4)
</p></li><li><p>A C++ compiler and linker. Tested with gcc(g++).</p>
</li>
<li><p>Optional: <a href="https://riverbankcomputing.com/software/qscintilla/download">Qscintilla2</a> library
and its development parts. You can use built-in QScintilla2 support in <span class="application">Sqliteman</span> instead.</p></li><li><p>Then read the README file in the root directory.</p></li></ul></div><p>
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="Requirements.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="Installation.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="Configuration.html">Next</a></td></tr>
<tr>
<td width="40%" align="left" valign="top">Requirements </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Contents</a>
</td>
<td width="40%" align="right" valign="top"> Configuration</td>
</tr>
</table>
</div>
</body></html>
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=UTF-8">
<title>Compilation and Installation</title>
<link rel="stylesheet"
href="kde-default.css" type="text/css">
<meta name="keywords"
content="Sqliteman, SQL, Sqlite, development, database">
<link rel="start"
href="index.html" title="The Sqliteman Handbook">
<link rel="up"
href="Installation.html" title="Appendix A. Installation">
<link rel="prev"
href="Requirements.html" title="Requirements">
<link rel="next"
href="Configuration.html" title="Configuration">
</head>
<body bgcolor="white" text="black"
link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<td width="20%" align="left"></td>
<th width="60%" align="center">
Appendix A. Installation
</th>
<td width="20%" align="right"></td>
</tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="Requirements.html">Prev</a>
</td>
<th width="60%" align="center">
Compilation and Installation
</th>
<td width="20%" align="right">
<a accesskey="n" href="Configuration.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="sect1" lang="en">
<div class="titlepage">
<h2 class="title" style="clear: both">
<a name="compilation"></a>
Compilation and Installation
</h2>
</div>
<p>
Some more tools are required for compiling
<span class="application">sqliteman</span>
from source code:
</p>
<p></p>
<div class="itemizedlist">
<ul type="disc">
<li>
<p>
<a href="http://cmake.org" target="_top">Cmake</a>
build system
</p>
</li>
<li>
<p>
<a href="https://www.qt.io/download-open-source/">
Qt5
</a>
library with its development parts (headers etc.)
<br>
(<span class="application">sqliteman</span>
versions before 1.8.1 will build with Qt4)
</p>
</li>
<li>
<p>
A C++ compiler and linker. Tested with gcc(g++).
</p>
</li>
<li>
<p>
Optional:
<a href="https://riverbankcomputing.com/software/qscintilla/download">
Qscintilla2
</a>
library and its development parts.
You can use the built-in QScintilla2 support in the
<span class="application">sqliteman</span>
sources instead.
</p>
</li>
<li>
<p>
Then read the README file in the root directory.
</p>
</li>
</ul>
</div>
<p></p>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="Requirements.html">Prev</a>
</td>
<td width="20%" align="center">
<span class="fileref">Compilation.html</span>
</td>
<td width="40%" align="right">
<a accesskey="n" href="Configuration.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
Requirements
</td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Contents</a>
</td>
<td width="40%" align="right" valign="top">
Configuration
</td>
</tr>
</table>
</div>
</body>
</html>
154 changes: 107 additions & 47 deletions Sqliteman/sqliteman/doc/en/Configuration.html
View file
Original file line number Diff line number Diff line change
@@ -1,48 +1,108 @@
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>Configuration</title><link rel="stylesheet" href="kde-default.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.67.2"><meta name="keywords" content="Sqliteman, SQL, Sqlite, development, database"><link rel="start" href="index.html" title="The Sqliteman Handbook"><link rel="up" href="Installation.html" title="Appendix A. Installation"><link rel="prev" href="Compilation.html" title="Compilation and Installation"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Configuration</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="Compilation.html">Prev</a> </td><th width="60%" align="center">Appendix A. Installation</th><td width="20%" align="right"> <a accesskey="n" href="DefaultValues.html">Next</a></td></tr></table><hr></div><div class="sect1" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="configuration"></a>Configuration</h2></div></div>
</div>
<p>Configuration for <span class="application">Sqliteman</span> is stored in the following places:
</p>
<p>
</p>
<div class="variablelist">
<dl>
<dt><span class="term">MS Windows</span></dt>
<dd><p>In the system registry:
<span>
<strong class="command">\\HKEY_CURRENT_USER\Software\yarpen.cz\sqliteman</strong>
</span>
</p></dd>
<dt><span class="term">LINUX</span></dt>
<dd><p>In the home directory:
<span><strong class="command">~/.config/sqlitemanrc</strong></span>
</p></dd>
</dl>
<html>
<head>
<meta http-equiv="Content-Type"
content="text/html; charset=UTF-8">
<title>Configuration</title>
<link rel="stylesheet"
href="kde-default.css" type="text/css">
<meta name="keywords"
content="Sqliteman, SQL, Sqlite, development, database">
<link rel="start"
href="index.html" title="The Sqliteman Handbook">
<link rel="up"
href="Installation.html" title="Appendix A. Installation">
<link rel="prev"
href="Compilation.html" title="Compilation and Installation">
</head>
<body bgcolor="white" text="black"
link="#0000FF" vlink="#840084" alink="#0000FF">
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr>
<td width="20%" align="left"></td>
<th width="60%" align="center">
Appendix A. Installation
</th>
<td width="20%" align="right"></td>
</tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="Compilation.html">Prev</a>
</td>
<th width="60%" align="center">
Configuration
</th>
<td width="20%" align="right">
<a accesskey="n" href="DefaultValues.html">Next</a>
</td>
</tr>
</table>
<hr>
</div>
<p></p>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="Compilation.html">Prev</a>
</td>
<td width="20%" align="center">
<a accesskey="u" href="Installation.html">Up</a>
</td>
<td width="40%" align="right">
<a accesskey="n" href="DefaultValues.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
Compilation and Installation
</td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Contents</a>
</td>
<td width="40%" align="right" valign="top">Default values</td>
</tr>
</table>
</div>
</body></html>
<div class="sect1" lang="en">
<div class="titlepage">
<h2 class="title" style="clear: both">
<a name="configuration"></a>
Configuration
</h2>
</div>
<p>
Configuration for
<span class="application">sqliteman</span>
is stored in the following places:
</p>
<p></p>
<div class="variablelist">
<dl>
<dt>
<span class="term">MS Windows</span>
</dt>
<dd>
<p>In the system registry:
<strong class="command">
\\HKEY_CURRENT_USER\Software\yarpen.cz\sqliteman
</strong>
</p>
</dd>
<dt>
<span class="term">LINUX</span>
</dt>
<dd>
<p>
In the home directory:
<strong class="command">
~/.config/sqlitemanrc
</strong>
</p>
</dd>
</dl>
</div>
<p></p>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="Compilation.html">Prev</a>
</td>
<td width="20%" align="center">
<span class="fileref">Configuration.html</span>
</td>
<td width="40%" align="right">
<a accesskey="n" href="DefaultValues.html">Next</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">
Compilation and Installation
</td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Contents</a>
</td>
<td width="40%" align="right" valign="top">Default values</td>
</tr>
</table>
</div>
</body>
</html>
Loading

0 comments on commit 081a514

Please sign in to comment.