Merge pull request #6 from Numigi/TA#65337-bis

TA#65337 [ADD] readme
Numigi · Jun 14, 2024 · bda5b75 · bda5b75
2 parents 038391e + 1c228a5
commit bda5b75
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 34 deletions.
diff --git a/project_milestone_spent_hours/README.rst b/project_milestone_spent_hours/README.rst
diff --git a/project_milestone_spent_hours/readme/CONTEXT.md b/project_milestone_spent_hours/readme/CONTEXT.md
@@ -0,0 +1,5 @@
+The module `project_milestone` allows to define Milestones for a Project.
+
+Multiple tasks in the project can be linked to a given milestone.
+
+Field `Total Hours` is displayed in form and list views of a Project Milestone and in the tab of Milestones of a Project.
diff --git a/project_milestone_spent_hours/readme/CONTRIBUTORS.md b/project_milestone_spent_hours/readme/CONTRIBUTORS.md
@@ -0,0 +1 @@
+- Numigi (tm) and all its contributors (https://bit.ly/numigiens)
diff --git a/project_milestone_spent_hours/readme/DESCRIPTION.md b/project_milestone_spent_hours/readme/DESCRIPTION.md
@@ -0,0 +1,3 @@
+This module adds a new field `Total Hours` on Milestone form view.
+
+The field `Total Hours`  is the sum of timesheets of active tasks associated to the Milestone.
diff --git a/project_milestone_spent_hours/readme/USAGE.md b/project_milestone_spent_hours/readme/USAGE.md
@@ -0,0 +1,9 @@
+As a `Project/User`, I create timesheets and set `Duration` for 2 tasks associated to the same Milestone.
+
+![task 1](../static/description/task1.png)
+
+![task 2](../static/description/task2.png)
+
+I open the Milestone, the field `Total Hours` is set with the **sum of timesheets spent hours** of associated tasks.
+
+![milestone](../static/description/milestone.png)