Skip to content

Commit

Permalink
update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
wasi0013 committed Nov 8, 2023
1 parent 2d5d8fb commit 8d1bda4
Showing 1 changed file with 17 additions and 7 deletions.
24 changes: 17 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,17 @@ Screenshots
Installing PyTM
---------------

* First download and install the latest version of `Python 3 <https://python.org/download/>`_ (Python 3.12+ is required).
* First download and install `pyenv <https://github.com/pyenv/pyenv#installation>`_. Use the command::

curl https://pyenv.run | bash

* Next, install Python 3.12 using the command::

pyenv install 3.12.0

Alternatively, you can skip pyenv installation and download python 3.12 or above from the official website and setup a virtualenv as well.


* Next, install PyTM from `PyPI <https://pypi.org/project/python-pytm/>`_ using :code:`pip`::

python -m pip install python-pytm
Expand All @@ -76,26 +86,26 @@ To see the available commands type::

Commands related to projects
============================

* Start a new/existing project: :code:`pytm project start PROJECT_NAME`
* Start a new project with a default name: :code:`pytm project start`
* Start a new project with the given name or, start an existing project: :code:`pytm project start PROJECT_NAME`
* Rename a project: :code:`pytm project rename OLD_PROJECT_NAME NEW_NAME`
* Remove a project: :code:`pytm project remove PROJECT_NAME`
* Check the status of a project: :code:`pytm project status PROJECT_NAME`
* Check the list of tasks and duration of a project: :code:`pytm project summary PROJECT_NAME`
* Finish active project: :code:`pytm project finish`
* Pause active project: :code:`pytm project pause`
* Abort active project: :code:`pytm project abort`
* Rename a project: :code:`pytm project rename OLD_PROJECT_NAME NEW_NAME`

Commands related to Task
========================

* Start a new or existing task in the current active project: :code:`pytm task start TASK_NAME`
* Start a new task with a default name in the current active project: :code:`pytm task start`
* Start a new task with the given name or existing task in the current active project: :code:`pytm task start TASK_NAME`
* Rename a task of the active project: :code:`pytm task rename OLD_TASK_NAME NEW_NAME`
* Remove a task: :code:`pytm task remove TASK_NAME`
* current task's status: :code:`pytm task status`
* Finish active task: :code:`pytm task finish`
* Pause active task: :code:`pytm task pause`
* Abort active task: :code:`pytm task abort`
* Rename a task of the active project: :code:`pytm task rename OLD_TASK_NAME NEW_NAME`

Others
======
Expand Down

0 comments on commit 8d1bda4

Please sign in to comment.