π End-to-end encrypted cloud for everything.
Dart 2faandroidauthye2eeencryptionend-to-end-encryptionfluttergolanggoogle-photosgoogle-photos-alternativeiosopensourcephotosprivacyprivacy-toolstypescriptzero-knowledge
[docs] Prune redundant package READMEs
laurensprieme08ff39dbc2d
diff --git a/mobile/packages/ente_qr/README.md b/mobile/packages/ente_qr/README.mddeleted file mode 100644index 49209809e4..0000000000--- a/mobile/packages/ente_qr/README.md+++ /dev/null@@ -1,177 +0,0 @@-# ente_qr--A Flutter plugin for scanning QR codes from image files. This plugin provides a simple interface to scan QR codes from images across Ente mobile and desktop apps.--## Features--- Scan QR codes from image files-- Support for Android using zxing-cpp-- Support for iOS and macOS using Vision-- Dart fallback for desktop platforms without native plugin support-- Returns structured results with error handling-- Works with images from file picker or camera--## Platform Support--| Platform | Support |-| -------- | ------- |-| Android | β |-| iOS | β |-| Web | β |-| macOS | β |-| Windows | β |-| Linux | β |--## Installation--Add this to your package's `pubspec.yaml` file:--```yaml-dependencies:- ente_qr:- path: path/to/ente_qr-```--## Usage--### Basic Usage--```dart-import 'package:ente_qr/ente_qr.dart';--final qr = EnteQr();--// Scan QR code from an image file-final result = await qr.scanQrFromImage('/path/to/image.jpg');--if (result.success) {- print('QR Code content: ${result.content}');-} else {- print('Error: ${result.error}');-}-```--### Complete Example with File Picker--```dart-import 'package:flutter/material.dart';-import 'package:ente_qr/ente_qr.dart';-import 'package:file_picker/file_picker.dart';--class QrScannerPage extends StatefulWidget {- @override- _QrScannerPageState createState() => _QrScannerPageState();-}--class _QrScannerPageState extends State<QrScannerPage> {- final _enteQr = EnteQr();- String _result = 'No QR code scanned';-- Future<void> _scanQrFromImage() async {- // Pick an image file- FilePickerResult? fileResult = await FilePicker.platform.pickFiles(- type: FileType.image,- allowMultiple: false,- );-- if (fileResult != null && fileResult.files.single.path != null) {- final imagePath = fileResult.files.single.path!;-- // Scan QR code from the selected image- final qrResult = await _enteQr.scanQrFromImage(imagePath);-- setState(() {- if (qrResult.success) {- _result = 'QR Code: ${qrResult.content}';- } else {- _result = 'Error: ${qrResult.error}';- }- });- }- }-- @override- Widget build(BuildContext context) {- return Scaffold(- appBar: AppBar(title: Text('QR Scanner')),- body: Column(- children: [- ElevatedButton(- onPressed: _scanQrFromImage,- child: Text('Pick Image and Scan QR'),- ),- Text(_result),- ],- ),- );- }-}-```--## API Reference--### EnteQr--The main class for QR code scanning operations.--#### Methods--##### `scanQrFromImage(String imagePath)`--Scans a QR code from an image file.--**Parameters:**--- `imagePath` (String): The file path to the image containing the QR code--**Returns:**--- `Future<QrScanResult>`: A result object containing either the QR code content or an error--### QrScanResult--The result object returned by QR scanning operations.--**Properties:**--- `content` (String?): The QR code content if successful, null otherwise-- `error` (String?): Error message if scanning failed, null otherwise-- `success` (bool): Whether the scanning operation was successful--**Factory Constructors:**--- `QrScanResult.success(String content)`: Creates a successful result-- `QrScanResult.error(String error)`: Creates an error result--## Implementation Details--### Android--The Android implementation uses the ZXing library (com.google.zxing) for QR code detection:--- `com.journeyapps:zxing-android-embedded:4.3.0`-- `com.google.zxing:core:3.5.1`--### iOS--The iOS implementation uses Core Image framework's built-in QR code detection capabilities via `CIDetector`.--## Error Handling--The plugin provides comprehensive error handling for common scenarios:--- File not found-- Invalid image format-- No QR code found in image-- Platform-specific errors-- Unexpected errors--All errors are returned as part of the `QrScanResult` object with descriptive error messages.--## Contributing--Contributions are welcome! Please feel free to submit a Pull Request.--## License--This project is licensed under the same license as the Ente project.diff --git a/rust/README.md b/rust/README.mdindex fde9c104ae..dc41764292 100644--- a/rust/README.md+++ b/rust/README.md@@ -21,7 +21,19 @@ Other useful commands:cargo codegen native # Regenerate bindings used by native appscargo codegen frb # Regenerate bindings used by Flutter appscargo codegen napi # Regenerate bindings used by Desktop (Electron) apps+```++## Integration tests++Integration tests use [ente-test-support](crates/test-support) to start a local+Museum backed by temporary Postgres and object storage. They require `go` on+`PATH` to build and run Museum. The Postgres binary+([postgresql_embedded](https://crates.io/crates/postgresql_embedded)) is downloaded+and cached on first use.-# Run integration tests against a local Museum+These tests are gated behind the `museum` feature, so a plain `cargo test` skips+them. To run them:++```shcargo test --features museum,ente-ml/ml-assets```diff --git a/rust/apps/cli/README.md b/rust/apps/cli/README.mdindex 060cc1b0a0..1d1d5fbf8b 100644--- a/rust/apps/cli/README.md+++ b/rust/apps/cli/README.md@@ -9,7 +9,8 @@ cargo run --bin ente-rs -- --help## Integration testsThe integration tests run against a live Museum spun up by-[ente-test-support](../../crates/test-support) (see its README for setup). They+[ente-test-support](../../crates/test-support) (see the+[setup instructions](../../README.md#integration-tests)). Theyare gated behind the `museum` Cargo feature, so a plain `cargo test -p ente-rs`skips them. To run them:diff --git a/rust/crates/test-support/README.md b/rust/crates/test-support/README.mddeleted file mode 100644index 4864e0d89d..0000000000--- a/rust/crates/test-support/README.md+++ /dev/null@@ -1,15 +0,0 @@-# ente-test-support--Runs a local Museum backed by temporary Postgres and object storage for use by various Rust integration tests.--## Setup--Requires `go` on PATH to build and run Museum. The Postgres binary ([postgresql_embedded](https://crates.io/crates/postgresql_embedded)) is downloaded and cached on first use.--## Usage--Tests that use it are gated behind a Cargo feature so that a plain `cargo test` skips them. They can be run by enabling the `museum` feature, e.g.:--```sh-cargo test -p ente-rs --features museum-```