Clarifications in instructions

Question

Clarifications in instructions

davidweichiang opened this issue 2 years ago · comments

The URL in the git clone step uses a git URL, which didn't work for me; I had to change to https.
If you install directly from git, then the command python3 aclpubcheck/formatchecker.py ... won't work.
Please explain what PAPER_TYPE is.

Ryan Cotterell · Answer 1 · Mon Mar 14 2022 07:50:02 GMT+0800 (China Standard Time)

Updated the instructions. What do you think? For bullet 2, I removed the direct installation as it's not useful for running the script.

David Chiang · Answer 2 · Mon Mar 14 2022 07:52:49 GMT+0800 (China Standard Time)

That helps (though the formatting of the double quotes is a little odd).

If you create an executable, then users will be able to use pip install directly from git, and the instructions also won't depend on them being in the correct directory.

Ryan Cotterell · Answer 3 · Mon Mar 14 2022 07:58:43 GMT+0800 (China Standard Time)

I fixed the double-quote formatting issue.

Can we create an executable that would also work on Windows?

David Chiang · Answer 4 · Mon Mar 14 2022 08:16:22 GMT+0800 (China Standard Time)

Sorry, I don't know...all the more reason to make it web-based...

Ryan Cotterell · Answer 5 · Mon Mar 14 2022 08:17:12 GMT+0800 (China Standard Time)

I agree. I'll close this issue and keep the web-based one up.