update to latest nikiroo-utils
[jvcard.git] / README.md
CommitLineData
b6feefc6 1# jVCard
f81b2ad9
N
2Small TUI (text mode) VCard manager (also supports abook files)
3
4## Current version
5
6- it can open VCF and ABOOK files
7- it can create a Swing terminal or use a real terminal (try "--help") using Lanterna 3 (which can be found here on GitHub, too)
8- it will list all the contacts of the file you select
9- it will show more detailed informations about a selected contact, including an ASCII art representation of their photo if any
176a8327 10- it can create/delete a contact
f81b2ad9
N
11- it can be used to edit your data (currently in RAW format, field by field)
12- it can save back to file
668268fc 13- English and French versions available (will look for the host language, can be forced with "--lang en")
88eb8122 14- remote synchronisation server (still in testing, but should work)
f81b2ad9
N
15
16## TODO
17
e27d1404
NR
18- [ ] lot of other things
19- [ ] correct UI for new contact/new data/edit data-types
20- [ ] update the screenshots
21- [ ] support escape as cancel in new X, new Y..
22- [ ] allow adding a new addressbook (and ask where to save it, offer current dir OR last input dir as default)
23- make sure it works OK for "jvcard.jar /dir/to/directory-full-of-vcf-files"
24- maybe a mode with 1 contact/file ?
25- and take the name from the contact to show in the list of "files" ?
26- add action "open as addressbook" ?
27- [x] find out why "R" is not displayed as a possible action (edit RAW) when viewing a contact)
28- it was missing in resources-en
29- [ ] add: modal dialogue -> "sub menu" (change the action keys) ? (maybe a "second action mode" and a copy of the MainContent)
30- [x] change --save-dir so that it saves ALL the translation files (open + scan dir?)
b6feefc6
N
31
32## Screenshots
33
34### Navigation
35
36![Opening a directory](http://nikiroo.be/jvcard/screenshots/open-dir.png)
37![Opening a VCF/aBook card](http://nikiroo.be/jvcard/screenshots/open-vcf.png)
38
39### Contact screen
40
41![Contact screen](http://nikiroo.be/jvcard/screenshots/open-contact.png)
42
43### Image modes
44
45![Double Dithering](http://nikiroo.be/jvcard/screenshots/image-dd.png)
46![ASCII](http://nikiroo.be/jvcard/screenshots/image-ascii.png)
47![Dithering](http://nikiroo.be/jvcard/screenshots/image-dithering.png)
48![Double Resolution](http://nikiroo.be/jvcard/screenshots/image-double.png)
49
50### Edit contact screen (Work In Progress)
51
52![Edit contact WIP](http://nikiroo.be/jvcard/screenshots/edit-contact.png)