Draft
Conversation
Contributor
|
Typically I don't mind if the README is However, the full documentation (in the If this PR is about the readme, just go with .md, but if this is starting to build the user documentation, do it in the doc folder and use .rst. |
sbillinge
reviewed
Aug 14, 2023
Contributor
sbillinge
left a comment
sbillinge
left a comment
There was a problem hiding this comment.
good start. I added one comment
|
|
||
| ## LICENSE | ||
|
|
||
| This software is subject to license and copyright restrictions listed here. |
Contributor
There was a problem hiding this comment.
I think we will make this open source, so let's give it a BSD-3 clause license.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 made a branch to add the
README.rstfile (like diffpy.pdfmorph). I'm not sure if this is automatically created by Sphinx or another process. I've only added the sections so far. Should I fill the file in a similar way toREADME.rstindiffpy.pdfmorph?