Change readme to reflect projec name change and scope

Signed-off-by: Joao Azevedo <joao.azevedo@puri.sm>
This commit is contained in:
Joao Azevedo 2020-07-26 16:01:16 +02:00
parent 3d35d67bc9
commit 85c0e7a4d2
1 changed files with 13 additions and 37 deletions

View File

@ -1,45 +1,21 @@
# diy contacts importer
# Librem 5 Goodies
This repo is just a place to dump experimental scripts to import VCF files.
This project serves to create a deb package with several bash scripts created for the Librem 5 phone.
**The use case for it is:**
Bring your script here and it might be packaged :tada:
- To allow a Librem 5 user that is migrating from Android to move his contacts as a vcf file to the Librem 5 and import
Please Avoid scripts that require cloning and building packages from source.
This issue is common to all projects that used Evolution (the database backend of gnome contacts) to manage contacts: Openmoko, Uuntu Touch
#### Scripts added to this package:
**Dependencies:**
---
- `yad`
- `syncevolution`
- `sed`
- `awk`
- `libnotify-bin`
|Script | Description | Dependencies | Notes |
|:--:|:--:|:--:|:--:|
|Contacts Importer| Allows to import contacts from a vcard file to gnome contacts. Can work with a UI, from command line interface|`yad`, `syncevolution`, `libnotify-bin`| This script will cease to exist when this https://gitlab.gnome.org/GNOME/gnome-contacts/-/merge_requests/105 is merged into GNOME Contacts and this feature is present in GNOME Contacts. |
**logic:** This script breaks down a vcf file with multiple contacts into multiple files. One vcard file per contact entry and imports them one by one.
#### Adding a script to this package:
The reason for this is that importing all the contacts at once from one single file with `syncevolution` is error prone.
**problems:** See the issues list.
This is only a quick and dirty bash script to do this task.
The proper way to do this: "having a easy way to import vcard files to the Librem 5/PureOS and GNOME, with GNOME Contacts and Evolution Data Server as a backend"
Would be to:
1. Someone writing a python/gtk application to do this.
2. (And even better) Someone submiting a patch to GNOME-Contacts for that application to support importing vcard files.
- https://gitlab.gnome.org/GNOME/gnome-contacts
- https://developer.gnome.org/eds/3.22/
**A new hope (Yes I am a Star Wars fan):** There has been recent activity to add the import vcard feature to gnome contacts.
When that happens, this package will have no reason to exit.
**Other References:**
- http://wiki.openmoko.org/wiki/Import_Vcf_Contacts#Import_and_Manage_Scripts
- https://www.isticktoit.net/?p=1536
- https://help.ubuntu.com/community/SyncEvolution/Synchronize-evolution-data-with-caldav-cardav-server
- https://syncevolution.org/wiki/thunderbird-phone-sync
- https://askubuntu.com/questions/360466/how-do-i-sync-contacts-on-ubuntu-touch
- Make a new branch based on the master branch and work from it.
- Make a merge request
- Avoid scripts that download and build source code