search

briederer / LatSpec.jl

A Julia Package for Lattice Spectroscopy
https://bernd1995.github.io/LatSpec.jl
MIT License
3 stars 1 forks source link

[WIP] Adding basic infos to Readme #19

Closed briederer closed 3 years ago

briederer commented 3 years ago

I've added general infos and the structure to the readme-file. I'll keep this PR open until everything is filled with at least the basics for each section.

fzierler commented 3 years ago

Looks good. I'd prefer if you add my uni-graz.at email instead of the other one. :)

briederer commented 3 years ago

I'd prefer if you add my uni-graz.at email instead of the other one. :) Sure no problem. Any other Contact details you would like to have in the readme?

fzierler commented 3 years ago

I'd prefer if you add my uni-graz.at email instead of the other one. :) Sure no problem.

Any other Contact details you would like to have in the readme?

Currently there are no other contact details. In case I change my mind on get a twitter account then I will update the readme. :)

briederer commented 3 years ago

Should we also set the README file as the main page for the docs?

fzierler commented 3 years ago

Please squash and force push on this branch before merging. The other email address already gets enough spam and the spam filter on it is quite lousy so I don't want it to be in this git-history. ;) Thank you!

Edit. If you want I can also do that before I merge.

briederer commented 3 years ago

I don't have time now, and it is not ready to be merged yet. But I'll do so then.

github-actions[bot] commented 3 years ago

The Docs for this PR are deployed! 🥳 You can find them here.

Please make sure that you have documented your new feature properly:

briederer commented 3 years ago

I guess this is ready now to be merged. It doesn't make sense to write the usage and Special Features section of the README-file before we have added functionality for that.