Skip to content

Commit 8a4db2d

Browse files
kwrkbclaude
andcommitted
Update documentation for cross-platform support
- Confirmed working on Windows - Updated README titles and descriptions - Added platform-specific prerequisites - Updated pyproject.toml classifiers for Windows/macOS/Linux - Changed description to 'Cross-platform PyQt6-based SQLite database browser' 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 0c80701 commit 8a4db2d

3 files changed

Lines changed: 47 additions & 10 deletions

File tree

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# SQLite Viewer for Ubuntu
2-
⚠️ This repository is an experimental project using AI tools such as Codex.
1+
# SQLite View
2+
⚠️ This repository is an experimental project using AI tools such as Codex.
33
It is shared for educational purposes only. Please note that it is provided *as is*, without warranty or official support.
44

5-
A lightweight PyQt6 desktop SQLite database viewer targeting Ubuntu desktops. The app lets you inspect tables, run ad-hoc queries, and export results—packaged for distribution via Python wheels or Debian packages.
5+
A lightweight, cross-platform PyQt6 desktop SQLite database viewer. The app lets you inspect tables, run ad-hoc queries, and export results—packaged for distribution via Python wheels or Debian packages.
66

77
## Features
88

@@ -12,15 +12,31 @@ A lightweight PyQt6 desktop SQLite database viewer targeting Ubuntu desktops. Th
1212
- Persistent recent files list for quick access
1313
- Debian package builder for Ubuntu (Python-dependent bundle)
1414

15+
## Tested Platforms
16+
17+
-**Windows** - Confirmed working
18+
-**Ubuntu/Linux** - Primary development platform
19+
-**macOS** - Not yet tested (feedback welcome!)
20+
1521
## Prerequisites
1622

17-
This application requires the following system libraries to be installed on Ubuntu:
23+
### Ubuntu/Linux
24+
25+
The following system libraries are required:
1826

1927
```bash
2028
sudo apt-get update
2129
sudo apt-get install -y libxcb-cursor0 libxkbcommon-x11-0 libxcb-icccm4 libxcb-keysyms1 libxcb-xkb1
2230
```
2331

32+
### Windows
33+
34+
No additional system libraries required. PyQt6 bundles all necessary dependencies.
35+
36+
### macOS
37+
38+
No additional system libraries required (not yet tested).
39+
2440
## Getting Started
2541

2642
### Option 1: Using uv (Recommended)

README_ja.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Ubuntu用SQLiteビューア
2-
⚠️ このリポジトリは Codex などの AI ツールでの実験成果です。
1+
# SQLite View
2+
⚠️ このリポジトリは Codex などの AI ツールでの実験成果です。
33
学習目的で公開しており、安定性やサポートは保証しません。
44

5-
Ubuntuデスクトップをターゲットにした、軽量なPyQt6製デスクトップSQLiteデータベースビューアです。このアプリでは、テーブルの閲覧、アドホックなクエリの実行、結果のエクスポートが可能です。PythonホイールまたはDebianパッケージ形式で配布されます。
5+
軽量なクロスプラットフォーム対応のPyQt6製デスクトップSQLiteデータベースビューアです。このアプリでは、テーブルの閲覧、アドホックなクエリの実行、結果のエクスポートが可能です。PythonホイールまたはDebianパッケージ形式で配布されます。
66

77
## 機能
88

@@ -12,15 +12,31 @@ Ubuntuデスクトップをターゲットにした、軽量なPyQt6製デスク
1212
- 素早いアクセスのための最近使用したファイル一覧の永続化
1313
- Ubuntu用のDebianパッケージビルダー(Python依存バンドル)
1414

15+
## 動作確認済みプラットフォーム
16+
17+
-**Windows** - 動作確認済み
18+
-**Ubuntu/Linux** - 主要開発環境
19+
-**macOS** - 未検証(フィードバック歓迎!)
20+
1521
## 前提条件
1622

17-
このアプリケーションをUbuntuにインストールするには、以下のシステムライブラリが必要です:
23+
### Ubuntu/Linux
24+
25+
以下のシステムライブラリが必要です:
1826

1927
```bash
2028
sudo apt-get update
2129
sudo apt-get install -y libxcb-cursor0 libxkbcommon-x11-0 libxcb-icccm4 libxcb-keysyms1 libxcb-xkb1
2230
```
2331

32+
### Windows
33+
34+
追加のシステムライブラリは不要です。PyQt6が必要な依存関係をすべて含んでいます。
35+
36+
### macOS
37+
38+
追加のシステムライブラリは不要です(未検証)。
39+
2440
## はじめに
2541

2642
### 方法1: uv を使う(推奨)

pyproject.toml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,24 @@ build-backend = "hatchling.build"
55
[project]
66
name = "sqliteview"
77
version = "0.2.1"
8-
description = "PyQt6-based SQLite database browser for Ubuntu"
8+
description = "Cross-platform PyQt6-based SQLite database browser"
99
readme = "README.md"
1010
authors = [
1111
{ name = "SQLite Viewer Team", email = "dev@example.com" }
1212
]
1313
license = { file = "LICENSE" }
1414
requires-python = ">=3.10"
15-
keywords = ["sqlite", "viewer", "pyqt6", "ubuntu"]
15+
keywords = ["sqlite", "viewer", "pyqt6", "cross-platform", "database", "gui"]
1616
classifiers = [
1717
"Programming Language :: Python :: 3",
1818
"Programming Language :: Python :: 3.10",
19+
"Programming Language :: Python :: 3.11",
20+
"Programming Language :: Python :: 3.12",
1921
"License :: OSI Approved :: MIT License",
22+
"Operating System :: OS Independent",
23+
"Operating System :: Microsoft :: Windows",
2024
"Operating System :: POSIX :: Linux",
25+
"Operating System :: MacOS",
2126
"Environment :: X11 Applications :: Qt",
2227
"Topic :: Database"
2328
]

0 commit comments

Comments
 (0)