Merge branch 'prepare-readme' into 'main'

# Contributing to Find My Device

Please follow the e Foundation contribution guidelines at [https://gitlab.e.foundation/groups/e/-/wikis/home](https://gitlab.e.foundation/groups/e/-/wikis/home).

## Reporting a bug

The Find my Device issue tracker is availaible at [this link](https://gitlab.e.foundation/groups/e/-/issues/?sort=updated_desc&state=opened&label_name%5B%5D=%2Fe%2FOS%20Find%20my%20device&first_page_size=100).

## Developing

Development guidelines are available at [https://gitlab.e.foundation/groups/e/-/wikis/home#development-processes](https://gitlab.e.foundation/groups/e/-/wikis/home#development-processes).

## Translating

You can translate this project at [https://i18n.e.foundation/projects/e/find-my-device/](https://i18n.e.foundation/projects/e/find-my-device/)

 No newline at end of file

# Find my Device

[![license](https://img.shields.io/badge/license-GPLv3-greenn.svg)](LICENSE)

[![doc](https://img.shields.io/badge/user-guide-green.svg)](https://doc.e.foundation/find-my-device) 

[![contributing](https://img.shields.io/badge/help-contributing-orange.svg)](CONTRIBUTING.md)

Find your smartphone when you lose it.

![Find my Device - disabled](.artifacts/Screenshot_Find my Device_disabled.png){height=600}

![Find my Device - configure](.artifacts/Screenshot_Find my Device_configure.png){height=600}

![Find my Device - enabled](.artifacts/Screenshot_Find my Device_enabled.png){height=600}

## Features

- Get the position of your device by SMS

## Run the project

1. Install /e/OS (min version: v3.0)

2. Configure Find my Device, and save the password

    - via the First Time Setup Wizard during the /e/OS installation

    - or via `Settings` > `Find my Device`

3. When needed, send a SMS to you smartphone with the password. As an answer, you will receive its position.

> 💡 This app intends to address the case when a user loses a smartphone. It does not cover a scenario when the device has been rebooted and/or when there is no SIM card (when the device is stolen for example).