d0c-s4vage/lookatme

Update README, tour gifs, and documentation

Open

#152 opened on Oct 3, 2022

View on GitHub
 (0 comments) (1 reaction) (0 assignees)Python (1,647 stars) (44 forks)batch import
bugdocumentationgood first issue

Description

Describe the bug The README, tour, and documentation is out of date. We need to update it to show:

  • Changes in command-line arguments (the -s conflict is resolved now)
  • The new progressive slide feature - <!-- stop --> in slides.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
familiarity with lookatmeunderstanding of markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the current README.md and any documentation files in the repository. Understand the new progressive slide feature by examining the code for the '<! stop >' syntax in slides. Check the command line interface code for the resolved ' s' conflict. Ensure changes are consistent with any other pending changes to avoid merge conflicts.