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

Replace original Readme file #4

Closed
wants to merge 3 commits into from
Closed

Conversation

ll7
Copy link
Contributor

@ll7 ll7 commented Jan 4, 2024

  • Rename README.md to README_old.md.
  • Create a new, simplified but "up-to-date" README.md

@ll7 ll7 marked this pull request as ready for review January 4, 2024 15:51
@Bonifatius94
Copy link
Owner

keep the readme to the point (good work). delete history entirely

@ll7
Copy link
Contributor Author

ll7 commented Jan 5, 2024

If we delete the history section and the README_old we also lose the acknowledgements and citations. I know that you like your repositories as clean as possible, but I think that these acknowledgements are important if we ever want to publish anything while using any code base or ideas from these references.

@Bonifatius94
Copy link
Owner

Sure, we can have acknowledgements and theoretical background in another markdown file. Also we can add the images from my M.Sc. presentation that outline the forces.

@ll7
Copy link
Contributor Author

ll7 commented Jan 5, 2024

Okay, that is a good compromise.

@Bonifatius94
Copy link
Owner

I've already cleaned up the README and pushed it on the main branch. Soon, I'll upload a THEORY.md as well. Thanks for your contribution.

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