Add global project description to README + french version

2024-06-26 01:17:35 +02:00
parent 4a66a8a202
commit 466ada80ad
3 changed files with 212 additions and 2 deletions
--- a/README.md
+++ b/README.md
@@ -1,5 +1,96 @@
 # video2geoframes.py

-Python script to generate a collection of geotagged images from a video and a GPS track.
+![Gitea Release](https://img.shields.io/gitea/v/release/lumathieu/video2geoframes.py?gitea_url=https%3A%2F%2Fgit.luc-geo.fr&include_prereleases&sort=semver&display_name=tag)

-Designed for contribution to street-level imagery projects like Mapillary or Panoramax.
+_🇬🇧 version_ / [_🇫🇷 version here_]()
+
+Python program to generate a collection of geotagged images from a video and a GPS track.
+
+Designed for ease contribution to street-level imagery projects like Mapillary or Panoramax.
+
+## Quick start
+
+Nothing simpler : collect your video, your GPS track, execute Python script and follow the guide !
+
+In detail, the program is built around a TUI or _Textual User Interface_, permitting to launch video process easily with
+step-by-step parameters input.
+
+Input is guided by textual help indicating attempted values.
+
+Before script starting, you need to have :
+* a video file with exact timestamp (start) in local time or UTC
+* a clean GPS tack file covering video duration
+* a working directory.
+
+## Documentation
+
+_Coming soon._
+
+## Features
+
+_Coming soon._
+
+### Comparison v1 / v2
+
+| Features                    | v1-beta    | v2-alpha9  |
+|-----------------------------|------------|------------|
+| Timelapse video support     | ✔️         | ✔️         |
+| EXIF tags writing           | ✔️         | ✔️         |
+| Extended tags support       | ✔️         | ❌          |
+| Milliseconds support        | ✔️         | ✔️         |
+| Progress displaying         | 🟡 raw     | ✔️         |
+| Multilingual TUI 🇺🇳       | 🟡 limited | ✔️         |
+| Configuration customization | ❌          | 🟡 partial | 
+| JPEG qualtiy customization  | ❌          | 🔄 planned |
+| TOML setting                | ❌          | 🔄 planned |
+
+## Languages
+ 
+TUI is multilingual thanks to "locales" base in the form of TOML files (`locales/*.toml`) easily extensible.
+
+| Languages    | Locale  | Support    | Maintainer   |
+|--------------|---------|------------|--------------|
+| 🇺🇸 English | `en_us` | ✔️ 100 %   | @lumathieu   |
+| 🇫🇷 French  | `fr_fr` | ✔️ 100 %   | @lumathieu   |
+| 🇮🇹 Italian | `it_it` | 🔄 planned | @lumathieu ? |
+
+## Versions
+
+See [_Releases_](https://git.luc-geo.fr/lumathieu/video2geoframes.py/releases).
+
+## Setup
+
+To set up program, be enough to clone Git repository, set up software dependencies and build Python environnement.
+Recommended to use a virtual environnement (venv).
+
+### Python
+
+Entire project is developed and tested on **Python 3.11** (Windows x86-64).
+
+### Dépendances
+
+Core script uses following Python libraries (see also `requirements.txt`) :
+- `numpy`
+- `opencv-python`
+- `piexif`
+- `tomlkit`
+- `tqdm`.
+
+## Compatibility
+
+Code is designed to be platform-independent.
+
+Official supported platforms are Windows and Linux (partially tested under Debian / Ubuntu).
+
+## Contribution
+
+_Coming soon._
+
+If you are interested to project contribution, you can send a mail to campanu@luc-geo.fr.
+
+## License
+
+This repository, except dependencies, is licensed under **GNU AGPL v3**.
+
+Dependencies are included in repository for development and keep their original license
+(see `dependencies/EXTRA_LICENSES.md`).