Getting Started

Welcome to the TinyExplorer FaceDetectionApp user guide. This section helps you install the application and become familiar with the interface.

Installation

Choose your operating system below for specific installation instructions:

macOSWindowsUbuntu/Linux

macOS Installation Guide

Since TinyExplorer FaceDetectionApp is not signed with an Apple Developer certificate, macOS requires additional steps to ensure the app can run safely on your system.

Step 1: Download the Application

1. Visit the Releases page
2. Download the latest .dmg file for macOS
3. Open the downloaded .dmg file
4. Drag TinyExplorer FaceDetectionApp to your Applications folder

Step 2: Remove Quarantine (Required)

Why is this necessary?

macOS quarantines unsigned applications downloaded from the internet for security. Since we don't have an Apple Developer certificate (which costs $99/year), you need to manually approve the app. This is safe as long as you downloaded it from our official GitHub releases.

1. Open Terminal (found in Applications → Utilities)
2. Type the following command but don't press Enter yet:

   sudo xattr -r -d com.apple.quarantine 
   

3. Add a space after the command
4. Drag and drop the TinyExplorer app from your Applications folder into the Terminal window
5. This will automatically add the correct path to your app
6. The complete command should look like:

   sudo xattr -r -d com.apple.quarantine /Applications/TinyExplorer\ FaceDetectionApp.app
   

7. Press Enter and type your Mac password when prompted

What does this command do?

• sudo - Runs the command with administrator privileges
• xattr - Modifies file attributes
• -r - Applies recursively to all files in the app
• -d com.apple.quarantine - Removes the quarantine flag
• The path points to your installed application

Step 3: Launch the Application

1. Go to your Applications folder
2. Double-click TinyExplorer FaceDetectionApp
3. If you see a security warning, click Open to proceed
4. The app will now launch successfully!

Installation Complete!

The app is now installed and ready to use. You only need to do this once.

Windows Installation Guide

Coming Soon

Windows installer is currently in development. Please check back later or build from source using the instructions below.

Build from Source (Temporary Solution)

1. Install Node.js (version 18 or higher)
2. Clone the repository:

   git clone https://github.com/cardiff-babylab/tinyexplorer-facedetectionapp.git
   cd tinyexplorer-facedetectionapp
   

3. Install dependencies:

   npm install
   

4. Start the application:

   npm run start
   

Ubuntu/Linux Installation Guide

Coming Soon

Linux AppImage/deb package is currently in development. Please check back later or build from source using the instructions below.

Build from Source (Temporary Solution)

1. Install Node.js and npm:

   sudo apt update
   sudo apt install nodejs npm
   

2. Clone the repository:

   git clone https://github.com/cardiff-babylab/tinyexplorer-facedetectionapp.git
   cd tinyexplorer-facedetectionapp
   

3. Install dependencies:

   npm install
   

4. Start the application:

   npm run start
   

First Launch

When you first launch the application, you'll see the main interface with all the controls needed for face detection.

Interface Overview

Main application interface showing file selection, model options, and confidence threshold controls

The main interface contains:

• File/Folder Selection – choose images or videos for processing
• Model Selection – pick the face detection model
• Confidence Threshold – adjust detection sensitivity
• Start – begin the recognition process
• Results Display – view detection outputs

See Also

• Basic Usage: installation options and local build steps — see Basic Usage.
• Supported File Types: list of compatible images and videos — see Supported File Formats.