Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add citing guidelines in README and docs #287

Merged
merged 11 commits into from
Apr 11, 2023
Merged

Add citing guidelines in README and docs #287

merged 11 commits into from
Apr 11, 2023

Conversation

MakisH
Copy link
Member

@MakisH MakisH commented Apr 11, 2023

This adds a citing section in our README.md:

Screenshot from 2023-04-11 16-38-53


It also updates the adapter overview page:

Screenshot from 2023-04-11 16-54-20


A question now is if we still need the rest of the references and history in the main README.md. @davidscn what do you think? Anything else to update?

  • I updated the documentation in docs/
  • I added a changelog entry in changelog-entries/ (create directory if missing)

@MakisH MakisH changed the title Add citing section in README.md Add citing guidelines in README and docs Apr 11, 2023
@MakisH MakisH self-assigned this Apr 11, 2023
@MakisH MakisH requested a review from davidscn April 11, 2023 13:55
@MakisH MakisH marked this pull request as ready for review April 11, 2023 13:55
Copy link
Member

@davidscn davidscn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I would remove the information in the README here and just put a link to the website information.

docs/README.md Outdated Show resolved Hide resolved
MakisH and others added 2 commits April 11, 2023 16:40
Co-authored-by: David Schneider <david.schneider@ipvs.uni-stuttgart.de>
@MakisH MakisH merged commit b0c383e into develop Apr 11, 2023
@MakisH MakisH deleted the add-ofj-to-readme branch April 11, 2023 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants