Skip to content

Commit fb109d6

Browse files
committed
Update documentation
1 parent 17434d1 commit fb109d6

File tree

2 files changed

+55
-1
lines changed

2 files changed

+55
-1
lines changed

README.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,53 @@
11
# Octave SQLITE Toolkit
22

3+
SQLITE database access for GNU Octave
4+
5+
## Overview
6+
37
This is a basic sqlite toolkit using and interface similar to
48
the Matlab Native SQLITE interface.
59

10+
It provides functionality for the following functions:
11+
12+
* sqlite
13+
* fetch
14+
* execute
15+
* sqlread
16+
* sqlwrite
17+
* commit
18+
* rollback
19+
* isopen
20+
21+
## Installing the Toolkit
22+
23+
The toolkit can be installed in Octave 4.0 and greater. It has a dependency
24+
on the SQLITE library (<https://www.sqlite.org/>), so it must be installed in
25+
order to successfully install the toolkit.
26+
27+
The toolkit can be installed in Octave 7.2+ using the command:
28+
29+
pkg install -forge sqlite
30+
31+
On older versions of Octave, install using the pull path to the latest released version:
32+
33+
pkg install "https://github.com/gnu-octave/octave-sqlite/archive/refs/tags/release-0.0.1.tar.gz"
34+
35+
After installation, load the package in order to use it.
36+
37+
pkg load sqlite
38+
39+
**Note:** The package needs to loaded each time Octave is run in order to use the package.
40+
41+
## Documentation
42+
43+
On newer versions of Octave, on loading the package the documentation will be available in the
44+
Octave documentation pages.
45+
46+
The Documentation is also installed as a pdf in the installed package folder.
47+
48+
An online summary of the documentation is also available at
649
https://github.com/gnu-octave/octave-sqlite/wiki/Octave-SQLITE-Toolkit
50+
51+
## Reporting Bugs
52+
53+
Bugs can be filed on the [issue tracker](https://github.com/gnu-octave/octave-sqlite/issues).

doc/octave-sqlite.texi

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,14 @@ With an internet connection available, the octave sqlite package can be installe
103103
the octave-sqlite website using the following command within @acronym{GNU} Octave:
104104

105105
@example
106-
pkg install https://sourceforge.net/projects/octave-sqlite/files/v@value{VERSION}/octave-sqlite-@value{VERSION}.tar.gz/download
106+
pkg install https://github.com/gnu-octave/octave-sqlite/archive/refs/tags/release-@value{VERSION}.tar.gz
107+
@end example
108+
109+
On Octave 7.2 and later, the package can be installed using the following command within
110+
@acronym{GNU} Octave:
111+
112+
@example
113+
pkg install -forge sqlite
107114
@end example
108115

109116
The latest released version of the toolkit will be downloaded and installed.

0 commit comments

Comments
 (0)