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 documentation #45

Merged
merged 3 commits into from
Apr 30, 2024
Merged

Update documentation #45

merged 3 commits into from
Apr 30, 2024

Conversation

newsch
Copy link
Collaborator

@newsch newsch commented Apr 28, 2024

  • Add warnings to commands that expect stdin
  • Add links to additional title/lang requirements
  • Reorganize README for readability

newsch added 3 commits April 28, 2024 14:26
Signed-off-by: Evan Lloyd New-Schmidt <evan@new-schmidt.com>
Signed-off-by: Evan Lloyd New-Schmidt <evan@new-schmidt.com>
Signed-off-by: Evan Lloyd New-Schmidt <evan@new-schmidt.com>
Copy link
Member

@biodranik biodranik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for updating the docs!


As an example of manual usage with the map generator:
As an example of manual usage with the maps generator:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it basically repeat/document what is done in the run.sh?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, without the parallel job handling and logging

@newsch newsch merged commit 1245d63 into main Apr 30, 2024
1 check passed
@newsch newsch deleted the docs branch April 30, 2024 16:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants