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.

Sign up for GitHub

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

Jump to bottom

Updating the ReadMe #81

Open
charvi-077 opened this issue Jan 9, 2025 · 2 comments
Open

Updating the ReadMe #81

charvi-077 opened this issue Jan 9, 2025 · 2 comments
Assignees
@amilworks @charvi-077
Labels
documentation Improvements or additions to documentation

Comments

@charvi-077
Copy link
Collaborator

@amilworks @connor11son @chandrakanth-gudavalli , As discussed yesterday, we need to update the BisQue ReadMe, so opening a separate issue to discuss further suggestions.

Here are some points that I am currently editing on :

  • Remove the current gif and make it more user interactive Intro for BisQue
  • To include the Developer guidelines separately
  • Include Recent Research Papers
  • Add BisQue Community Link
@amilworks amilworks self-assigned this Jan 9, 2025
@amilworks amilworks added the documentation Improvements or additions to documentation label Jan 9, 2025
@charvi-077 charvi-077 mentioned this issue Jan 13, 2025
Closed
@charvi-077
Copy link
Collaborator Author

@amilworks , @connor11son drafted the first version of updated ReadMe as here #85 . I am not sure of exact details to be added in citation and need to update the image as well to remove my user name !

charvi-077 added a commit to charvi-077/bisqueUCSB that referenced this issue Jan 14, 2025
@charvi-077
README.md : Fix the suggestions
e865159 
UCSB-VRL#81
@charvi-077
Copy link
Collaborator Author

TODO's after discussion :
Updating docker image link ReadMe
Adding citation
Updating the BisQue logo (maybe) and intro image
More Acknowledgments need to be added.
contribution guide

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@amilworks amilworks

@charvi-077 charvi-077

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@amilworks @charvi-077