From ddf85cdd066adde2ea116aec531e9c0a2373b1e1 Mon Sep 17 00:00:00 2001 From: Nika Zhenya Date: Fri, 12 Nov 2021 08:31:10 -0600 Subject: [PATCH] =?UTF-8?q?Propuesta=20de=20=C3=ADndice=20e=20intro=20--si?= =?UTF-8?q?n=20quickstart--?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/en/source/basic_usage.rst | 51 ++++++++++++++++++++++++++++++++-- docs/en/source/index.rst | 30 ++++++++++++++++++-- 2 files changed, 75 insertions(+), 6 deletions(-) diff --git a/docs/en/source/basic_usage.rst b/docs/en/source/basic_usage.rst index 0800113..5cb44a9 100644 --- a/docs/en/source/basic_usage.rst +++ b/docs/en/source/basic_usage.rst @@ -1,17 +1,62 @@ Intro ===== -What is tiempo +What is Tiempo -------------- -lorem +Tiempo is a command line time tracker. It helps you keep track of the time spent +in different activities optionally organized in projects or `sheets`. Tiempo is +also a `Timetrap`_ compatible command line time tracking application. + + Why another time tracking instead of improving Timetrap? + +* Timetrap is `hard to install`_, hard to keep `updated`_ (because of Ruby). + With Tiempo you can get or build a binary, put it somewhere, and it will + just work forever in that machine. I'm bundling SQLite. +* Timetrap is slow (no way around it, because of Ruby), some commands take up to + a second. Tiempo always feels snappy. +* Timetrap needed major refactor to fix the timezone problem (in a language I'm not + proficient with). I was aware of this problem and designed Tiempo to store + timestamps in UTC while at the same time being able to work with a database + made by Timetrap without messing up. And there are a lot of tests backing this + assertions. + +Tiempo has other advantages: + +* Fixed some input inconsistencies. +* Solved some old issues in Timetrap. +* Columns in the output are always aligned. +* CLI interface is easier to discover (ask ``-h`` for any sub-command) +* End times are printed with +1d to indicate that the activity ended the next + day in the 'text' formatter. Installation ------------ -ipsum +Just do: + +.. code:: bash + + cargo install tiempo + +If you use Arch Linux, install `tiempo-git` package from the `AUR`_, for example: + +.. code:: bash + + git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si + +.. NOTE:: + You need to install `Rust`_ and `Cargo`_. For more info `click here`_. Quickstart ---------- dolo + +.. _Timetrap: https://github.com/samg/timetrap/ +.. _hard to install: https://github.com/samg/timetrap/issues/176 +.. _updated: https://github.com/samg/timetrap/issues/174 +.. _click here: https://doc.rust-lang.org/cargo/getting-started/installation.html +.. _Rust: https://rust-lang.org +.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html +.. _AUR: https://aur.archlinux.org/packages/tiempo-git/ diff --git a/docs/en/source/index.rst b/docs/en/source/index.rst index ac67662..883d79f 100644 --- a/docs/en/source/index.rst +++ b/docs/en/source/index.rst @@ -9,18 +9,42 @@ Tiempo docs advanced_usage Tiempo is a command line time tracker. It helps you keep track of the time spent -in different activities optionally organized in projects or `sheets`. +in different activities optionally organized in projects or `sheets`. Tiempo is +also a `Timetrap`_ compatible command line time tracking application. Installation ------------ -just do +Just do: .. code:: bash cargo install tiempo +If you use Arch Linux, install `tiempo-git` package from the `AUR`_, for example: + +.. code:: bash + + git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si + +.. NOTE:: + You need to install `Rust`_ and `Cargo`_. For more info `click here`_. + Quickstart ---------- -Mention something maybe about the most useful commands? +Go `here`_... + +Special Thanks +-------------- + +To `Timetrap`_ for existing, to `samg`_ for creating it. It is the tool I was looking +for and whose design I took as reference, keeping compatibility when possible. + +.. _Timetrap: https://github.com/samg/timetrap/ +.. _samg: https://github.com/samg +.. _here: basic_usage.html#quickstart +.. _click here: https://doc.rust-lang.org/cargo/getting-started/installation.html +.. _Rust: https://rust-lang.org +.. _Cargo: https://doc.rust-lang.org/book/ch01-03-hello-cargo.html +.. _AUR: https://aur.archlinux.org/packages/tiempo-git/