Improve readme #2745
Merged
Improve readme #2745
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mbollmann
approved these changes
Aug 20, 2023
There was a problem hiding this comment.
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.
akoehn
reviewed
Aug 20, 2023
xinru1414
pushed a commit
that referenced
this pull request
Aug 31, 2023
* updates readme regarding folder names * adds quickstart info * adds transitional text
anthology-assist
added a commit
that referenced
this pull request
Oct 13, 2023
* 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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
buildfolder after generation, so I added the info that you need to copy the files fromhugointobuildbefore running Hugo.