diff options
| author | Tristan Riehs <tristan.riehs@inria.fr> | 2026-03-22 15:57:20 +0100 |
|---|---|---|
| committer | Tristan Riehs <tristan.riehs@inria.fr> | 2026-03-22 15:57:20 +0100 |
| commit | 13f2ed054dad14d59544542e3a0567b28fa1feb1 (patch) | |
| tree | cb5cd0e528fbc204781139e4c198275e3f976df6 | |
| parent | 56652b7e253e70af37c18c8c50da896b0cfd77e3 (diff) | |
Revamp the "getting started" part of the readme
| -rw-r--r-- | README.org | 38 |
1 files changed, 26 insertions, 12 deletions
@@ -30,31 +30,45 @@ $ make * Getting started -First, initialize Ftag: +** Initialize Ftag #+begin_src console $ ftag init #+end_src -Second, write all my documents' file names, which are in the =~/paperwork= -directory, to a temporary file: +** Add a document to the database + +This will prompt for some information about the file and encrypt it with your +default GPG key. Run ~ftag file add -h~ for more information. + +#+begin_src console +$ ftag file add ~/documents/id_card.pdf +#+end_src + +From now, let's say you entered the full name "ID Card" and the canonical name +"id_card". + +** Create a tag #+begin_src console -$ find ~/paperwork -type f -fprint0 /tmp/files +$ ftag tag add id Identity #+end_src -Third, give them to =ftag file add= using =xargs= to add them all to the Ftag database: +** Add this tag to the file #+begin_src console -$ xargs -0 -a /tmp/files ftag file add -i +$ ftag file tag id_card id #+end_src -Fourth, create a bunch of tags and give files the proper tags (very tedious, but -this is the only time we will have to do it manually for numerous files): +** Done! +You have set up your Ftag database. You can check by querying it. + #+begin_src console -$ ftag tag add -[...] -$ ftag file tag -[...] +$ ftag query -t id #+end_src + +** Going further + +This was a hello-world walk-through. You may get advices about how to insert +numerous existing files to a Ftag database by running ~ftag file add -h~. |
