Write a publicly facing README #1374
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I have surveyed a few projects such as numpy, cern-root or tensorflow and put in the things that looked relevant from their Readme. I think this should have the appropriate pointers modulo things like the reference to the code paper. Closes #1358.
Contributor
Author
|
I would also like to link the result from #1373 here. |
Member
|
As a first try, this looks ok to me. I would include some extra badges after making the repo public. |
Member
|
Looks fine to me. After the repo is made public and the paper is out the appropiate links and badges should be added, but for now it's ok. |
scarlehoff
approved these changes
Aug 26, 2021
scarrazza
approved these changes
Aug 26, 2021
scarrazza
reviewed
Aug 27, 2021
Co-authored-by: Stefano Carrazza <[email protected]>
scarrazza
reviewed
Aug 27, 2021
siranipour
reviewed
Aug 27, 2021
Co-authored-by: Roy Stegeman <[email protected]> Co-authored-by: siranipour <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have surveyed a few projects such as numpy, cern-root or tensorflow
and put in the things that looked relevant from their Readme. I think
this should have the appropriate pointers modulo things like the
reference to the code paper.
Closes #1358.