Uploaded image for project: 'IGB'
  1. IGB
  2. IGBF-1861

Improve README for Genoviz library

    Details

    • Type: Task
    • Status: Closed (View Workflow)
    • Priority: Major
    • Resolution: Done
    • Affects Version/s: None
    • Fix Version/s: None
    • Labels:

      Description

      Go to https://bitbucket.org/lorainelab/genoviz-sdk/src/master/

      Scroll down. Note that no "README" text is shown. That's because Bitbucket displays README.md (markdown) files in this location.

      For this task, we need to include a README.md that provides basic information about the Genoviz SDK.

      Add a README.md file that includes:

      • brief summary of what Genoviz SDK is
      • link to Pubmed record for BMC Bioinformatics paper introducing Genoviz (see Loraine Lab web site publications page for article link)
      • instructions on how to build it (if not obvious)
      • location of maven repository (can find it in IGB POM)
      • license information (can link to license file if available)
      • explanation of tutorial; warning that it is using applets and is not working

      When that is done, remove README.txt

      Use fork-and-branch workflow (same as with IGB)

        Attachments

          Activity

          ann.loraine Ann Loraine created issue -
          ann.loraine Ann Loraine made changes -
          Field Original Value New Value
          Epic Link IGBF-1531 [ 17617 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          ann.loraine Ann Loraine made changes -
          Assignee Ann Loraine [ aloraine ]
          prutha Prutha Kulkarni (Inactive) made changes -
          Assignee Prutha Kulkarni [ prutha ]
          ann.loraine Ann Loraine made changes -
          Sprint Summer 2019 Sprint 10 [ 69 ] Summer 2019 Sprint 10, Summer 2019 Sprint 11 [ 69, 70 ]
          ann.loraine Ann Loraine made changes -
          Rank Ranked higher
          prutha Prutha Kulkarni (Inactive) made changes -
          Status Open [ 1 ] In Progress [ 3 ]
          prutha Prutha Kulkarni (Inactive) made changes -
          Assignee Prutha Kulkarni [ prutha ]
          prutha Prutha Kulkarni (Inactive) made changes -
          Status In Progress [ 3 ] Needs 1st Level Review [ 10005 ]
          ann.loraine Ann Loraine made changes -
          Status Needs 1st Level Review [ 10005 ] Ready for Pull Request [ 10304 ]
          ann.loraine Ann Loraine made changes -
          Assignee Prutha Kulkarni [ prutha ]
          prutha Prutha Kulkarni (Inactive) made changes -
          Assignee Prutha Kulkarni [ prutha ]
          prutha Prutha Kulkarni (Inactive) made changes -
          Status Ready for Pull Request [ 10304 ] Pull Request Submitted [ 10101 ]
          ann.loraine Ann Loraine made changes -
          Resolution Done [ 10000 ]
          Status Pull Request Submitted [ 10101 ] Closed [ 6 ]
          ann.loraine Ann Loraine made changes -
          Workflow Loraine Lab Workflow [ 18584 ] Fall 2019 Workflow Update [ 20262 ]
          ann.loraine Ann Loraine made changes -
          Workflow Fall 2019 Workflow Update [ 20262 ] Revised Fall 2019 Workflow Update [ 22406 ]
          ann.loraine Ann Loraine made changes -
          Assignee Prutha Kulkarni [ prutha ]

            People

            • Assignee:
              prutha Prutha Kulkarni (Inactive)
              Reporter:
              ann.loraine Ann Loraine
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: