mirror of
https://github.com/sqlitebrowser/sqlitebrowser.git
synced 2026-01-20 02:50:46 -06:00
Convert README to Markdown
This lets us use exactly the same content for the README and the GitHub Pages based website.
This commit is contained in:
Justin Clift
119
README.md
Normal file
119
README.md
Normal file
@@ -0,0 +1,119 @@
|
||||
|
||||
|
||||
## What it is
|
||||
|
||||
SQLite Database Browser is a high quality, visual, open source tool to create, design, and edit database files compatible with SQLite.
|
||||
|
||||
It is for users and developers wanting to create databases, search, and edit data. It uses a familiar spreadsheet-like interface, and you don't need to learn complicated SQL commands.
|
||||
|
||||
Controls and wizards are available for users to:
|
||||
|
||||
* Create and compact database files
|
||||
* Create, define, modify and delete tables
|
||||
* Create, define and delete indexes
|
||||
* Browse, edit, add and delete records
|
||||
* Search records
|
||||
* Import and export records as text
|
||||
* Import and export tables from/to CSV files
|
||||
* Import and export databases from/to SQL dump files
|
||||
* Issue SQL queries and inspect the results
|
||||
* Examine a log of all SQL commands issued by the application
|
||||
|
||||
## What it is not
|
||||
|
||||
This program is not a visual shell for the sqlite command line tool. It does not require familiarity with SQL commands. It is a tool to be used both by developers and by end users, and it must remain as simple to use as possible in order to achieve its goals.
|
||||
|
||||
## License
|
||||
|
||||
SQLite Database Browser is bi-licensed under the Mozilla Public License
|
||||
Version 2, as well as the GNU General Public License Version 3 or later.
|
||||
|
||||
You can modify or redistribute it under the conditions of these
|
||||
licenses.
|
||||
|
||||
## What's been done since the SourceForge project
|
||||
|
||||
* Qt3Support was removed
|
||||
* Recent files menu added
|
||||
* Improved UI, making it more modern, replacing some dialogs etc.
|
||||
* Syntax highlighting for SQL code
|
||||
* Cleaned up the code, reducing the SLOC quite a bit
|
||||
* Added basic support for triggers and views
|
||||
* Added pragma editing
|
||||
* Added BLOB support
|
||||
* Added a new filter row for searching
|
||||
* Improved performance when opening large tables
|
||||
* Extended the SQL tab
|
||||
* Added SQLite extension support
|
||||
* Fixed a ton of bugs
|
||||
* Probably more
|
||||
|
||||
All in all a fair amount of the code has been rewritten in order to regain
|
||||
maintainability. Based on this quite a few bugs can be fixed and new
|
||||
features added.
|
||||
|
||||
## What's still to do
|
||||
|
||||
* Even more code cleanup
|
||||
* Further improvement of the UI, adding more features and making it easier to use
|
||||
* Feel free to add more issues at
|
||||
https://github.com/sqlitebrowser/sqlitebrowser/issues
|
||||
|
||||
## Windows binaries
|
||||
|
||||
Windows binaries can be downloaded from here:
|
||||
|
||||
* https://github.com/sqlitebrowser/sqlitebrowser/releases
|
||||
|
||||
Nightly builds are also available at:
|
||||
|
||||
* http://rp.oldsch00l.com/sqlitebrowser/
|
||||
|
||||
## MacOS X
|
||||
|
||||
SQLite Database Browser works well on MacOS X.
|
||||
|
||||
* OSX 10.7 (Lion) and 10.8 (Mountain Lion) are tested and known to work
|
||||
|
||||
Building on OSX is simple, but depends on SQLite and Qt 4.8.x being installed
|
||||
using Homebrew first::
|
||||
|
||||
$ brew install sqlite --with-functions
|
||||
$ brew install qt --with-qt3support
|
||||
|
||||
Then it's just a matter of::
|
||||
|
||||
$ git clone https://github.com/sqlitebrowser/sqlitebrowser.git
|
||||
$ cd sqlitebrowser
|
||||
$ qmake
|
||||
$ make
|
||||
$ mv src/sqlitebrowser.app /Applications/
|
||||
|
||||
An icon for "sqlitebrowser" should now be in your main OSX Applications
|
||||
list, ready to launch.
|
||||
|
||||
## Old project pages
|
||||
|
||||
* http://sqlitebrowser.sourceforge.net
|
||||
* https://sourceforge.net/projects/sqlitebrowser
|
||||
|
||||
## Releases
|
||||
|
||||
* [Version 3.0.3 released](https://github.com/sqlitebrowser/sqlitebrowser/releases/tag/sqlb-3.0.3) - 2014-04-28
|
||||
* [Version 3.0.2 released](https://github.com/sqlitebrowser/sqlitebrowser/releases/tag/sqlb-3.0.2) - 2014-02-12
|
||||
* [Version 3.0.1 released](https://github.com/sqlitebrowser/sqlitebrowser/releases/tag/sqlb-3.0.1) - 2013-12-02
|
||||
* [Version 3.0 released](https://github.com/sqlitebrowser/sqlitebrowser/releases/tag/sqlb-3.0) - 2013-09-15
|
||||
* [Version 3.0rc1 released](https://github.com/sqlitebrowser/sqlitebrowser/releases/tag/rc1) - 2013-09-09 - Project now on GitHub
|
||||
* Version 2.0b1 released - 2009-12-10 - Based on Qt4.6
|
||||
* Version 1.2 released - 2005-04-05
|
||||
* Version 1.1 released - 2004-07-20
|
||||
* Version 1.01 released - 2003-10-02
|
||||
* Version 1.0 released to public domain - 2003-08-19
|
||||
|
||||
## History
|
||||
|
||||
This program was developed originally by Mauricio Piacentini (@piacentini) from Tabuleiro Producoes, as the Arca Database Browser. The original version was used as a free companion tool to the Arca Database Xtra, a commercial product that embeds SQLite databases with some additional extensions to handle compressed and binary data.
|
||||
|
||||
The original code was trimmed and adjusted to be compatible with standard SQLite 2.x databases. The resulting program was renamed SQLite Database Browser, and released into the Public Domain by Mauricio. Icons were contributed by Raquel Ravanini, also from Tabuleiro. Jens Miltner contributed the code to support SQLite 3.x databases for the 1.2 release.
|
||||
|
||||
Pete Morgan (@daffodil) created an initial project on GitHub with the code in 2012, where several contributors fixed and improved pieces over the years. René Peinthor (@rp-) and Martin Kleusberg (@MKleusberg) then became involved, and have been the main driving force from that point. Justin Clift (@justinclift) helps out with testing on OSX, and started the new github.com/sqlitebrowser organisation on GitHub.
|
||||
101
README.rst
101
README.rst
@@ -1,101 +0,0 @@
|
||||
=======================
|
||||
SQLite Database Browser
|
||||
=======================
|
||||
|
||||
This is the official home of the SQLite Database Browser project, previously
|
||||
housed on SourceForge.
|
||||
|
||||
Screenshot
|
||||
----------
|
||||
|
||||
.. image:: https://github.com/sqlitebrowser/sqlitebrowser/raw/master/images/sqlitebrowser.png
|
||||
:height: 641px
|
||||
:width: 725px
|
||||
:scale: 100%
|
||||
:alt: SQLiteBrowser Screenshot
|
||||
:align: center
|
||||
|
||||
New Project website
|
||||
-------------------
|
||||
|
||||
- http://sqlitebrowser.org
|
||||
|
||||
Old Project Pages
|
||||
-----------------
|
||||
|
||||
- http://sqlitebrowser.sourceforge.net
|
||||
- https://sourceforge.net/projects/sqlitebrowser/
|
||||
|
||||
What it is
|
||||
----------
|
||||
|
||||
SQLite Database Browser is a free, open source visual tool used to create,
|
||||
design and edit database files compatible with SQLite. It is meant to be used
|
||||
by users and developers wanting to create databases, edit and search data
|
||||
using a familiar spreadsheet-like interface, without the need to learn
|
||||
complicated SQL commands.
|
||||
|
||||
What's been done since then
|
||||
---------------------------
|
||||
|
||||
- Qt3Support was removed
|
||||
- Recent files menu added
|
||||
- Improved UI, making it more modern, replacing some dialogs etc.
|
||||
- Syntax highlighting for SQL code
|
||||
- Cleaned up the code, reducing the SLOC quite a bit
|
||||
- Added basic support for triggers and views
|
||||
- Added pragma editing
|
||||
- Added BLOB support
|
||||
- Added a new filter row for searching
|
||||
- Improved performance when opening large tables
|
||||
- Extended the SQL tab
|
||||
- Added SQLite extension support
|
||||
- Fixed a ton of bugs
|
||||
- Probably more
|
||||
|
||||
All in all a fair amount of the code has been rewritten in order to regain
|
||||
maintainability. Based on this quite a few bugs could be fixed and some
|
||||
features added.
|
||||
|
||||
What's still to do
|
||||
------------------
|
||||
|
||||
- Even more code cleanup
|
||||
- Further improvement of the UI, adding more features and making it easier to
|
||||
use
|
||||
- Feel free to add more issues at
|
||||
https://github.com/sqlitebrowser/sqlitebrowser/issues
|
||||
|
||||
Windows binaries
|
||||
----------------
|
||||
Windows binaries can be downloaded from here:
|
||||
|
||||
- https://github.com/sqlitebrowser/sqlitebrowser/releases
|
||||
|
||||
Nightly builds are also available at:
|
||||
|
||||
- http://rp.oldsch00l.com/sqlitebrowser/
|
||||
|
||||
MacOS X
|
||||
-------
|
||||
|
||||
SQLite Database Browser works pretty well on MacOS X.
|
||||
|
||||
- OSX 10.7 (Lion) and 10.8 (Mountain Lion) are tested and known to work
|
||||
|
||||
Building on OSX is simple, but depends on SQLite and Qt to be installed
|
||||
using Homebrew first::
|
||||
|
||||
$ brew install sqlite --with-functions
|
||||
$ brew install qt --with-qt3support
|
||||
|
||||
Then it's just a matter of::
|
||||
|
||||
$ git clone https://github.com/sqlitebrowser/sqlitebrowser.git
|
||||
$ cd sqlitebrowser
|
||||
$ qmake
|
||||
$ make
|
||||
$ mv src/sqlitebrowser.app /Applications/
|
||||
|
||||
An icon for "sqlitebrowser" should now be in your main OSX Applications
|
||||
list, ready to launch.
|
||||
Reference in New Issue
Block a user