[Question] Is the example usage the most optimal?

[samgdotson]

Question or discussion topic.

Is the example usage described in the README.md the best usage?

Provide details.

First, the current usage has potential users

1. Cloning the repository
2. Moving their LaTeX files to a subdirectory called 'input'
3. Running a bash script from that repository.

This usage feels awkward and clunky which disincentivizes the use of this tool. Ideally, I would be able to install this script (e.g., through pypi) and run the checker from anywhere without moving any files.

Second, it seems like the desire for this project is to fully automate the writing checklist. A wonderful goal. However, given the performance issues raised in #7, I'm not sure a bash script will ever be smart enough to run the checklist automatically. To resolve this, I propose making the checker interactive, such that people may decide whether to adopt certain changes before those changes are made. This is commonly done with command line spell checkers (e.g., aspell).

How can this issue be closed?

This issue may be closed when there has been sufficient discussion about the intended usage of this tool.