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.

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

Update readme to describe analysis #66

Closed
SebastianZimmeck opened this issue Sep 22, 2023 · 1 comment
Closed

Update readme to describe analysis #66

SebastianZimmeck opened this issue Sep 22, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@SebastianZimmeck
Copy link
Member

Currently, the readme explains the analysis by referring to the OptMeowt analysis mode:

It automatically runs OptMeowt Analysis mode on all the given sites of the input csv file in Firefox.

However, the analysis mode is no longer in the current version of OptMeowt. So, this may be slightly confusing (at least, I was confused, thinking that OptMeowt still has the analysis mode). Thus, @katehausladen, could you rewrite the crawler repo, to the extent necessary, describing what is currently described via the link in the OptMeowt repo? So, directly include in the crawler repo what is important to know.

@SebastianZimmeck SebastianZimmeck added the documentation Improvements or additions to documentation label Sep 22, 2023
katehausladen added a commit that referenced this issue Sep 25, 2023
@katehausladen
Copy link
Collaborator

There was an updated description of analysis functionality in the architecture section of the readme. I removed the OptMeowt Analysis mode reference at the beginning and pointed readers to that section for details on analysis functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
2 participants