Add Readme

[Tieqiong]

Fix #12

How it looks like after cookiecut

Need discussion and changes:

• project icon -- Higher resolution -- Make it the GitHub org avatar?
• Badges -- DOI -- Test
• Contributor.rst in diffpy.utils?

[Tieqiong]

@sbillinge Thanks for the comments!

1. I'm thinking of changing the avatar of the diffpy GitHub account from the default to the diffpy icon. This is beneficial because 1. It makes the cookie cutter easier to fit for both diffpy and non-diffpy packages (if we are going to have a different icon for a non-diffpy package) and 2. make the diffpy account looks cool.
2. I linked the Test badge to Matplotlib GH workflow (test.yml to be more precise) because we were talking about adding a test badge yesterday and Matplotlib created this badge (not a lot of packages have this test badge) by having the test.yml in their workflow. It might be not worth it to add another file in our workflow so I'm thinking of other ways.
3. Yes instead of having individual and separate DOI for each release of the packages (like what scikit learn does) many other packages (like Numpy and Scipy) link to the paper. I also think having the paper DOI placed here is a great idea.
4. Yes I'll check and add more precise instructions on testing.
5. Sounds good, will add a new section "Reporting Bugs, issues and requesting features".
6. I'll think about text that can encourages the community to get involved. One problem is diffpy.utils doesn't have a separate Contribution page but I assume we have one in the cookiecutter template.
7. I'll make diffpy.org to be the web link here. Do we want to consider the case for non-diffpy packages?

[sbillinge]

@sbillinge Thanks for the comments!

1. I'm thinking of changing the avatar of the diffpy GitHub account from the default to the diffpy icon. This is beneficial because 1. It makes the cookie cutter easier to fit for both diffpy and non-diffpy packages (if we are going to have a different icon for a non-diffpy package) and 2. make the diffpy account looks cool.

2. I linked the Test badge to Matplotlib GH workflow (test.yml to be more precise) because we were talking about adding a test badge yesterday and Matplotlib created this badge (not a lot of packages have this test badge) by having the test.yml in their workflow. It might be not worth it to add another file in our workflow so I'm thinking of other ways.

3. Yes instead of having individual and separate DOI for each release of the packages (like what scikit learn does) many other packages (like Numpy and Scipy) link to the paper. I also think having the paper DOI placed here is a great idea.

4. Yes I'll check and add more precise instructions on testing.

5. Sounds good, will add a new section "Reporting Bugs, issues and requesting features".

6. I'll think about text that can encourages the community to get involved. One problem is diffpy.utils doesn't have a separate Contribution page but I assume we have one in the cookiecutter template.

7. I'll make diffpy.org to be the web link here. Do we want to consider the case for non-diffpy packages?

sounds good. Make the changes and we can review. For 7, it is a good point. I am a bit reluctant to add more questions, but we could add a "link to diffpy.org?" question and have default y but allow n. If n is selected, just put nothing there as the documentation will basically be the README itself (and any github.io docs)

[Tieqiong]

Preview

@sbillinge things left:

1. We don't need to add a "link to diffpy.org" question anymore (thanks to @Sparks29032), but a doi question could be helpful for both the doi badge and citation link
2. I added the google user groups. What about the non-diffpy packages?
3. I linked to a code of conduct part (as suggested) so we need an extra CODE_OF_COUNDUCT.rst (see #83)
4. I modified the install section a little bit. The pip install in check integrity is to install the package requirement for testing (namely pytest-mock and freezegun). I believe it's necessary or there'll be errors
5. Now I'm using the Github avatar as the project icon, so we need to change the diffpy organization avatar to the diffpy icon to see the right img

[sbillinge]

Preview

@sbillinge things left:

1. We don't need to add a "link to diffpy.org" question anymore (thanks to @Sparks29032), but a doi question could be helpful for both the doi badge and citation link

2. I added the google user groups. What about the non-diffpy packages?

3. I linked to a code of conduct part (as suggested) so we need an extra CODE_OF_COUNDUCT.rst (see [Add code of conduct #83](https://github.com/Billingegroup/cookiecutter/pull/83))

4. I modified the install section a little bit. The `pip install` in check integrity is to install the package requirement for testing (namely pytest-mock and freezegun). I believe it's necessary or there'll be errors

5. Now I'm using the Github avatar as the project icon, so we need to change the diffpy organization avatar to the diffpy icon to see the right img

1. we don't need a DOI question or a doi badge. We can hard-code text as a place-holder for a citation link that will be filled in later. No question needed. We won't have this info at the time of creating the repo.
2. For the user group we don't use diffpy-dev. Please just have them join diffpy-users. They can post bugs there too (they do anyway). We just use that one place for all the group code, so we can use the same user-group also for non-diffpy packages.
3. I saw the code of conduct. I left a comment, but basically, it looks great.
4. In that case, let's remove that. We don't want users installing those things in their envs. We can just remove that text. It is mostly only needed for apps anyway, not packages per se (do you ever do that for numpy for example?)
5. ok, I can do that.

[Tieqiong]

Preview