Skip to content
This repository was archived by the owner on Mar 12, 2024. It is now read-only.

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dikayx committed Nov 24, 2023
1 parent b6ceb70 commit 22c1cb6
Showing 1 changed file with 26 additions and 4 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# SQLite Viewer

A desktop application to view and edit SQLite databases. It is written in Java and uses the SQLite JDBC driver.

[![Java 11](https://img.shields.io/badge/Java-11-blue.svg)](https://www.oracle.com/java/technologies/javase-jdk11-downloads.html)
Expand All @@ -19,23 +20,44 @@ A desktop application to view and edit SQLite databases. It is written in Java a
<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/solar.png">

## Install
- [Download](https://github.com/dan-koller/sqlite-viewer/releases/tag/v1.1.0) the .jar file from the release section _or_
- [Clone](https://github.com/dan-koller/sqlite-viewer) this repository and compile it yourself

- [Download](https://github.com/dan-koller/sqlite-viewer/releases/tag/v1.1.0) the .jar file from the release section
_or_
- [Clone](https://github.com/dan-koller/sqlite-viewer) this repository and compile it yourself using `./gradlew build`

<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/solar.png">

## How to use
## Usage

- Load a Sqlite `*.db` file from disk from the menu
- Open it by clicking `Connect`
- Select the table you want to edit or view
- Enter a SQL query in the text area and click `Execute` to run it
- See the result in the area below

_To get started you can download a sample file from sqlitetutorial.net [here](https://www.sqlitetutorial.net/sqlite-sample-database/)._
_To get started you can download a sample file from
sqlitetutorial.net [here](https://www.sqlitetutorial.net/sqlite-sample-database/)._

<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/solar.png">

## Known issues

- On **Unix-like** systems, double-clicking the jar file does not work in certain directory structures. In this case, you
can run the jar file from the command line using `java -jar sqlite-viewer.jar` or place the jar file somewhere else.

_Unix-like systems like **Linux** and **macOS** are - unlike Windows - using the home directory as the current working directory
when double-clicking a jar file._

<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/solar.png">

## Technologies

- Java 11
- Gradle 7.4.1
- SQLite 3

<img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/solar.png">

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

0 comments on commit 22c1cb6

Please sign in to comment.