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

                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: