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

              Ascending order - Click to sort in descending order
              Hide
              Permalink
              prutha Prutha Kulkarni (Inactive) added a comment -

              Prof. [~aloraine], I am unable to figure out what to add in the "explanation of tutorial" section of the README file.
              Could you please help me with that?

              Show
              prutha Prutha Kulkarni (Inactive) added a comment - Prof. [~aloraine] , I am unable to figure out what to add in the "explanation of tutorial" section of the README file. Could you please help me with that?
              Hide
              Permalink
              prutha Prutha Kulkarni (Inactive) added a comment -

              Included a READE.md file with
              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 (not added because it was obvious)
              location of maven repository
              license information (added a license file for more information)
              explanation of tutorial

              The README.md file id available at:
              https://bitbucket.org/lorainelab/genoviz-sdk/src/IGBF-1861/

              Show
              prutha Prutha Kulkarni (Inactive) added a comment - Included a READE.md file with 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 (not added because it was obvious) location of maven repository license information (added a license file for more information) explanation of tutorial The README.md file id available at: https://bitbucket.org/lorainelab/genoviz-sdk/src/IGBF-1861/
              Hide
              Permalink
              ann.loraine Ann Loraine added a comment -

              This is good - thank you! Go ahead and submit a pull request.

              I will probably add a few things once it's merged to master.

              Show
              ann.loraine Ann Loraine added a comment - This is good - thank you! Go ahead and submit a pull request. I will probably add a few things once it's merged to master.
              Hide
              Permalink
              prutha Prutha Kulkarni (Inactive) added a comment -

              Pull request is submitted for the same.
              The code changes are available at :
              https://bitbucket.org/lorainelab/genoviz-sdk/pull-requests/16/igbf-1861-improve-readme-for-genoviz/diff
              Prof. [~aloraine], could you please merge it into the master?
              Thanks.

              Show
              prutha Prutha Kulkarni (Inactive) added a comment - Pull request is submitted for the same. The code changes are available at : https://bitbucket.org/lorainelab/genoviz-sdk/pull-requests/16/igbf-1861-improve-readme-for-genoviz/diff Prof. [~aloraine] , could you please merge it into the master? Thanks.
              Hide
              Permalink
              ann.loraine Ann Loraine added a comment -

              Merged and moved to Closed.

              Show
              ann.loraine Ann Loraine added a comment - Merged and moved to Closed.

                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: