aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Riehs <tristan.riehs@inria.fr>2026-02-17 18:35:01 +0100
committerTristan Riehs <tristan.riehs@inria.fr>2026-02-17 18:35:01 +0100
commit684159bcf8287bcb569eaa41d0ca1a37437c94c6 (patch)
tree5ad2a528bef7adb32fb37a428a3c52f4f03a84f0
parentdfe8d9780ee4aa8daad68cb9376a41717949ca08 (diff)
Slightly reorganize readme
-rw-r--r--README.org43
1 files changed, 11 insertions, 32 deletions
diff --git a/README.org b/README.org
index dfbb13f..2503603 100644
--- a/README.org
+++ b/README.org
@@ -19,9 +19,16 @@ build Ftag in a way that:
- allows encryption of documents;
- allows synchronizing the data on multiple machine.
-* Examples
+* Installation
-** Migrating to Ftag
+#+begin_src console
+$ git clone https://tristanriehs.fr/git/ftag
+$ cd ftag
+$ make
+# make install
+#+end_src
+
+* Getting started
First, initialize Ftag:
@@ -29,7 +36,8 @@ First, initialize Ftag:
$ ftag init
#+end_src
-Second, write all my documents' file names to a temporary file:
+Second, write all my documents' file names, which are in the =~/paperwork=
+directory, to a temporary file:
#+begin_src console
$ find ~/paperwork -type f -fprint0 /tmp/files
@@ -50,32 +58,3 @@ $ ftag tag add
$ ftag file tag
[...]
#+end_src
-
-** Take a look at all my car insurance files
-
-#+begin_src console
-$ ftag query -t car -t insurance
-#+end_src
-
-
-* Installation
-
-#+begin_src console
-$ git clone https://tristanriehs.fr/git/ftag
-$ cd ftag
-$ make
-# make install
-#+end_src
-
-* Getting started
-
-#+begin_src console
-$ ftag init
-$ ftag file add ~/paperwork/my_first_document.pdf
-$ ftag file list
-My First Document
-$ ftag tad add my_first_tag "This is my first tag"
-$ ftag file tag my_first_document my_first_tag
-$ ftag query -t my_first_tag
-My First Document
-#+end_src