-
Notifications
You must be signed in to change notification settings - Fork 283
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
Improve readme #2745
Improve readme #2745
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, that looks good to me!
I wonder to what extent we need to describe the "manual" build steps at all. In principle, everything should be doable through the Makefile, as the individual build steps should all have their own make target anyway. I guess that's another thing we could make clearer in the future.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Forgot to submit my comments ...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the edits!
* updates readme regarding folder names * adds quickstart info * adds transitional text
* ingested jeptalnrecital volume coria. * ingested jeptalnrecital volume rjc. * ingested jeptalnrecital volume arts. * ingested jeptalnrecital volume deft. * Updated ingestion scripts with volume tag * added missing volume attribute * black * Update metadata from Papers with Code * CCL 2023 Ingestion (#2735) * Updates to README (#2745) * updates readme regarding folder names * adds quickstart info * adds transitional text * Backlinked missing ACL workshops (#2720) * Linked missing workshops from ACL * Organized workshops in 2023.ws under their parent event with an XML comment * Anthology code now skips comments when parsing * TSAR 2022 fixes (#2363) (#2751) * backlinked missing workshop from EMNLP 2022 * added DOIs * ingested long. * ingested short. * ingested statement. * ingested international. * ingested volume demos. * ingested volume proj. * fixed \\ issue. * updated one pdf. --------- Co-authored-by: Matt Post <mattpost@microsoft.com> Co-authored-by: acl-pwc-bot <94475230+acl-pwc-bot@users.noreply.github.com> Co-authored-by: Christopher Schölzel <christopher.schoelzel@mailbox.org> Co-authored-by: Matt Post <post@cs.jhu.edu>
During my work on #358, I noticed a few parts of the README_detailed.md that could be improved in my opinion. I didn't want to conflate this with the code and page changes, so I created a separate branch.
When I first read the README, I missed the part that mentioned the
Makefile
, so I thought it would make sense to make this more prominent and give a TLDR version for the hasty reader. 😉In the more detailed description afterward, there was some confusion about where generated files would end up. I guess this has changed since the README was written, but wasn't updated here.
Finally, I was confused that not all the required files were in the
build
folder after generation, so I added the info that you need to copy the files fromhugo
intobuild
before running Hugo.