Skip to content

NO-JIRA: README improvements#22

Merged
asfgit merged 3 commits into
apache:masterfrom
dnwe:improve-readmes
Apr 24, 2015
Merged

NO-JIRA: README improvements#22
asfgit merged 3 commits into
apache:masterfrom
dnwe:improve-readmes

Conversation

@dnwe
Copy link
Copy Markdown
Member

@dnwe dnwe commented Apr 24, 2015

  • remove out-of-date product information from the README and include the more
    current information from the website
  • add a new INSTALL file to contain the build and install instructions
    from the existing README
  • move all development and testing related info from that to the
    DEVELOPERS file
  • better explain how to run the various test suites and how they work
    across proton-c and proton-j in the developers file
  • other misc improvements across the contents of the files
  • rename DEVELOPERS and INSTALL to have .md suffixes for better
    rendering on GitHub
  • add a symlink from README --> README.md for better landing page
    rendering on GitHub

* remove out-of-date product information from the README and include the more
  current information from the website
* add a new INSTALL file to contain the build and install instructions
  from the existing README
* move all development and testing related info from that to the
  DEVELOPERS file
* better explain how to run the various test suites and how they work
  across proton-c and proton-j in the developers file
* other misc improvements across the contents of the files
* rename DEVELOPERS and INSTALL to have .md suffixes for better
  rendering on GitHub
* add a symlink from README --> README.md for better landing page
  rendering on GitHub
@rhs
Copy link
Copy Markdown
Contributor

rhs commented Apr 24, 2015

+1

As a general note I think it's good to try to test changes to install/readme type stuff on people who aren't already intimately familiar with proton and all its various quirks. I wouldn't hold up merging this for that though.

Nice work, BTW! It's great to see this sort of stuff get cleaned up!

@asfgit asfgit merged commit c1a6de2 into apache:master Apr 24, 2015
@dnwe
Copy link
Copy Markdown
Member Author

dnwe commented Apr 24, 2015

I've sent these off to be further reviewed by a few people round here to see if I can determine further improvements., Have merged them in as-is for now as I believe they're a decent first pass at improving what we currently had.

@mcpierce fyi, this will require an update to the rpm qpid-proton.spec to account for the new file extension of README.md

@asfbot
Copy link
Copy Markdown

asfbot commented Apr 24, 2015

Abhay Saxena on proton@qpid.apache.org replies:
Make install tries to install README instead of README.md.

asfgit pushed a commit that referenced this pull request Apr 27, 2015
Closes #22

(cherry picked from commit c1a6de2)
@tkettenba tkettenba mentioned this pull request Jan 22, 2021
SudhanAruna added a commit to SudhanAruna/qpid-proton that referenced this pull request Jun 21, 2021
* test_message: Fixed the failing test testAnnotationsSymbolicAndUlongKey

Signed-off-by: Arunagirinadan Sudharshan <sudhan.aruna.97@gmail.com>

* codec test: WIP fixing codec test errors

Signed-off-by: Arunagirinadan Sudharshan <sudhan.aruna.97@gmail.com>

* codec test: WIP fixing codec test errors

Signed-off-by: Arunagirinadan Sudharshan <sudhan.aruna.97@gmail.com>

* fix remaining tests

Co-authored-by: Jiri Daněk <jdanek@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants