Skip to content

Commit ee54c7b

Browse files
committed
ignore screenshots and docs for release
1 parent 40dbbd7 commit ee54c7b

2 files changed

Lines changed: 47 additions & 41 deletions

File tree

.gitattributes

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## * https://git-scm.com/docs/gitattributes
2+
## * https://softwareengineering.stackexchange.com/a/367655/381493
3+
4+
# exclude from the generated tarball
5+
docs export-ignore
6+
screenshots export-ignore
7+
README.adoc export-ignore

README.adoc

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
1-
= README
2-
:toc:
3-
:toclevels: 1
4-
:sectnums:
5-
:note-caption: :information_source:
6-
7-
== Introduction
8-
Modern SQL shells like `mssql-cli`, `mycli`, `SQLcl` and `pgcli` are very convenient: they offer auto-completion, syntax highlighting, query history, a multi-line editor, and much more.
9-
10-
`SQL Shell` makes using SQL clients even more convenient:
11-
12-
* a standard interface to enter connection parameters so you don't have to remember command line options
13-
* defaults for host name, port, and user to save you time
14-
* pre-defined connection strings for connection without typing
15-
* automatic tunneling if your database is behind a firewall or listening only on localhost interface
16-
* legacy client support (`sqlcmd`, `mysql`, `SQLPlus`, `psql`, `sqlite3`)
17-
18-
== Installation
19-
* Windows
20-
** copy `sql shell.exe` to a directory of your choice
21-
* Linux
22-
** install third-party Python modules `click`, `npyscreen`, `pycompat`, and `sshtunnel`
23-
** copy `sql shell.py` and `tunnel.py` to a directory of your choice
24-
* install SQL shell clients of your choice (https://github.com/dbcli/mssql-cli[`mssql-cli`], https://www.mycli.net[`mycli`], https://www.oracle.com/database/technologies/appdev/sqlcl.html[`SQLcl`], https://www.pgcli.com[`pgcli`], https://litecli.com[`litecli`])
25-
* optional: edit `sql shell.ini` and `tunnel.ini` to match your environment
26-
27-
== Usage
28-
[NOTE]
29-
If you can't get `SQL Shell` running or have questions, open a https://github.com/thorstenkampe/SQL-Shell/issues[ticket]
30-
31-
=== standard
32-
image::screenshots/standard.png[width=65%]
33-
34-
=== DSN
35-
image:screenshots/DSN.png[width=65%]
36-
37-
=== tunnel
38-
image:screenshots/tunnel.png[width=65%]
39-
40-
=== legacy client
41-
image:screenshots/legacy-client.png[width=65%]
1+
= README
2+
:toc:
3+
:toclevels: 1
4+
:sectnums:
5+
:note-caption: :information_source:
6+
7+
== Introduction
8+
Modern SQL shells like `mssql-cli`, `mycli`, `SQLcl` and `pgcli` are very convenient: they offer auto-completion, syntax highlighting, query history, a multi-line editor, and much more.
9+
10+
`SQL Shell` makes using SQL clients even more convenient:
11+
12+
* a standard interface to enter connection parameters so you don't have to remember command line options
13+
* defaults for host name, port, and user to save you time
14+
* pre-defined connection strings for connection without typing
15+
* automatic tunneling if your database is behind a firewall or listening only on localhost interface
16+
* legacy client support (`sqlcmd`, `mysql`, `SQLPlus`, `psql`, `sqlite3`)
17+
18+
== Requirements ==
19+
* Python modules `click`, `npyscreen`, `pycompat`, and `sshtunnel` (when using the source code files)
20+
* SQL shell clients (https://github.com/dbcli/mssql-cli[`mssql-cli`], https://www.mycli.net[`mycli`], https://www.oracle.com/database/technologies/appdev/sqlcl.html[`SQLcl`], https://www.pgcli.com[`pgcli`], https://litecli.com[`litecli`])
21+
22+
== Installation
23+
. download release (source code or Windows binary)
24+
. optional: edit `sql shell.ini` and `tunnel.ini` to match your environment
25+
26+
== Usage
27+
[NOTE]
28+
If you can't get `SQL Shell` running or have questions, open a https://github.com/thorstenkampe/SQL-Shell/issues[ticket]
29+
30+
=== standard
31+
image::screenshots/standard.png[width=65%]
32+
33+
=== DSN
34+
image:screenshots/DSN.png[width=65%]
35+
36+
=== tunnel
37+
image:screenshots/tunnel.png[width=65%]
38+
39+
=== legacy client
40+
image:screenshots/legacy-client.png[width=65%]

0 commit comments

Comments
 (0)