diff --git a/docs/en/source/basic_usage.rst b/docs/en/source/basic_usage.rst index 5cb44a9..581dddf 100644 --- a/docs/en/source/basic_usage.rst +++ b/docs/en/source/basic_usage.rst @@ -26,7 +26,7 @@ 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) +* 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. @@ -51,7 +51,7 @@ If you use Arch Linux, install `tiempo-git` package from the `AUR`_, for example Quickstart ---------- -dolo +TODO .. _Timetrap: https://github.com/samg/timetrap/ .. _hard to install: https://github.com/samg/timetrap/issues/176 diff --git a/docs/es/source/advanced_usage.rst b/docs/es/source/advanced_usage.rst new file mode 100644 index 0000000..6d3f977 --- /dev/null +++ b/docs/es/source/advanced_usage.rst @@ -0,0 +1,12 @@ +Advanced Usage +============== + +Subcommands +----------- + +bla + +Settings +-------- + +bla diff --git a/docs/es/source/basic_usage.rst b/docs/es/source/basic_usage.rst new file mode 100644 index 0000000..83a15f2 --- /dev/null +++ b/docs/es/source/basic_usage.rst @@ -0,0 +1,62 @@ +Introducción +============ + +¿Qué es Tiempo? +--------------- + +Tiempo es una herramienta de línea de comandos para rastrear el tiempo. Te ayuda a grabar +el tiempo empleado en diferentes actividades y de manera opcional te permite organizarlas +en proyectos o `sheets` (hojas). Tiempo es compatible con `Timetrap`_, su predecesor. + + ¿Por qué otro rastreador de tiempo en lugar de mejorar Timetrap? + +* Timetrap es `difícil de instalar`_, difícil de mantenerlo `actualizado`_ (debido a Ruby). + Con Tiempo puedes obtener o compilar un binario, ponerlo donde sea y simplemente funcionará + en la máquina. Estoy embebiendo SQLite. +* Timetrap es lento (no hay modo de sacarle la vuelta, es por Ruby), algunos comandos + tardan hasta un segundo. Tiempo siempre se siente rápido. +* Timetrap necesitaba una refactorización mayor para arreglar un problema con el huso + horario (en un lenguaje en el que no soy experto). Estaba al tanto de este problema + y diseñé Tiempo para guardar marcas de tiempo en UTC así como es posible + trabajar con la base de datos hecha por Timetrap sin estropearla. Y muchas pruebas + se han realizado que respaldan esta afirmación. + +Tiempo tiene otras ventajas: + +* Arreglé algunas inconsistencias en el input. +* Resolví algunas incidencias antiguas de Timetrap. +* Las columnas del output están siempre alineadas. +* La interfaz de línea de comandos es más fácil de descubrir (pregunta ``-h`` para cualquier subcomando). +* Los tiempos de conclusión se imprimen con un +1d para indicar que la actividad acabó al siguiente + día. + +Instalación +----------- + +Si tienes instaladas las herramientas de `Rust`_, solo ejecuta: + +.. code:: bash + + cargo install tiempo + +Si usas Arch Linux, instala el paquete `tiempo-git` desde `AUR`_, por ejemplo: + +.. code:: bash + + git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si + +.. NOTE:: + Requieres tener instalado `Rust`_ y `Cargo`_. Para más información haz `clic aquí`_. + +Inicio rápido +------------- + +TODO + +.. _Timetrap: https://github.com/samg/timetrap/ +.. _difícil de instalar: https://github.com/samg/timetrap/issues/176 +.. _actualizado: https://github.com/samg/timetrap/issues/174 +.. _clic aquí: 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/es/source/index.rst b/docs/es/source/index.rst index 8c8dd73..e657d44 100644 --- a/docs/es/source/index.rst +++ b/docs/es/source/index.rst @@ -1,20 +1,50 @@ -.. tiempo documentation master file, created by - sphinx-quickstart on Tue Oct 26 20:13:00 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to tiempo's documentation! -================================== +Documentación de Tiempo +======================= .. toctree:: :maxdepth: 2 - :caption: Contents: + :caption: Contenidos: + basic_usage + advanced_usage +Tiempo es una herramienta de línea de comandos para rastrear el tiempo. Te ayuda a grabar +el tiempo empleado en diferentes actividades y de manera opcional te permite organizarlas +en proyectos o `sheets` (hojas). Tiempo es compatible con `Timetrap`_, su predecesor. -Indices and tables -================== +Instalación +----------- -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +Si tienes instaladas las herramientas de `Rust`_, solo ejecuta: + +.. code:: bash + + cargo install tiempo + +Si usas Arch Linux, instala el paquete `tiempo-git` desde `AUR`_, por ejemplo: + +.. code:: bash + + git clone https://aur.archlinux.org/tiempo-git.git && cd tiempo-git && makepkg -si + +.. NOTE:: + Requieres tener instalado `Rust`_ y `Cargo`_. Para más información haz `clic aquí`_. + +Inicio rápido +------------- + +Ve `aquí`_... + +Agradecimientos especiales +-------------------------- + +A `Timetrap`_ por existir y a `samg`_ por hacerlo. Esta herramienta es lo que estaba +buscando y a la que tomé de referencia, manteniendo compatibilidad en lo posible. + +.. _Timetrap: https://github.com/samg/timetrap/ +.. _samg: https://github.com/samg +.. _aquí: basic_usage.html#inicio-rapido +.. _clic aquí: 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/