[task #15744] README.md including information on required resources

[Mohammad Akhlaghi]

URL:
  <https://savannah.nongnu.org/task/?15744>

                 Summary: README.md including information on required
resources
                 Project: Reproducible paper template
            Submitted by: makhlaghi
            Submitted on: Fri 07 Aug 2020 11:05:24 PM BST
         Should Start On: Fri 07 Aug 2020 12:00:00 AM BST
   Should be Finished on: Fri 07 Aug 2020 12:00:00 AM BST
                Category: Analysis
                Priority: 5 - Normal
                  Status: Postponed
                 Privacy: Public
        Percent Complete: 0%
             Assigned to: None
             Open/Closed: Open
         Discussion Lock: Any
                  Effort: 0.00

    _______________________________________________________

Details:

Currently a user of a Maneaged project has no special way to know what
resources they need to build the project. This can be a big reason that many
people may be reluctant to build a Maneaged project.

So I suggest we add a section in README.md to explain the necessary resources
for the project to run and encourage project authors to fill it before
submission (in the publication checklist). Currently I am thinking of these
resources but please suggest other fields to add:


### Necessary resources:

In order to build this project, the following resources are necessary:

Analysis phase running time: e.g., 1 min on 4-core CPU at 3GHz.
Raw input datasets (possibly by download): XXX Gb
RAM requirements: XXX Gb
Necessary storage (for build directory): XXX Gb
GPU: Yes/No
 




    _______________________________________________________

Reply to this item at:

  <https://savannah.nongnu.org/task/?15744>

_______________________________________________
  Message sent via Savannah
  https://savannah.nongnu.org/