You are viewing a plain text version of this content. The canonical link for it is here.
Posted to proton@qpid.apache.org by dnwe <gi...@git.apache.org> on 2015/04/24 14:36:26 UTC
[GitHub] qpid-proton pull request: NO-JIRA: README improvements
GitHub user dnwe opened a pull request:
https://github.com/apache/qpid-proton/pull/22
NO-JIRA: README improvements
* 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
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/dnwe/qpid-proton improve-readmes
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/qpid-proton/pull/22.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #22
----
commit b532cf25756424c840047ad039b5c43eeb864046
Author: Dominic Evans <do...@uk.ibm.com>
Date: 2015-04-24T11:14:17Z
NO-JIRA: README improvements
* 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
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
Re: [GitHub] qpid-proton pull request: NO-JIRA: README improvements
Posted by Abhay Saxena <ar...@datawire.io>.
Make install tries to install README instead of README.md.
On Fri, Apr 24, 2015 at 9:21 AM, dnwe <gi...@git.apache.org> wrote:
> Github user dnwe commented on the pull request:
>
> https://github.com/apache/qpid-proton/pull/22#issuecomment-95931032
>
> 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`
>
>
> ---
> If your project is set up for it, you can reply to this email and have your
> reply appear on GitHub as well. If your project does not have this feature
> enabled and wishes so, or if the feature is enabled but not working, please
> contact infrastructure at infrastructure@apache.org or file a JIRA ticket
> with INFRA.
> ---
>
[GitHub] qpid-proton pull request: NO-JIRA: README improvements
Posted by dnwe <gi...@git.apache.org>.
Github user dnwe commented on the pull request:
https://github.com/apache/qpid-proton/pull/22#issuecomment-95931032
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`
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] qpid-proton pull request: NO-JIRA: README improvements
Posted by rhs <gi...@git.apache.org>.
Github user rhs commented on the pull request:
https://github.com/apache/qpid-proton/pull/22#issuecomment-95922186
+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!
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] qpid-proton pull request: NO-JIRA: README improvements
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/qpid-proton/pull/22
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---