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 (44 forks)batch import
bugdocumentationgood first issue

Repository metrics

Stars
 (1,647 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the current README and documentation, then update them to reflect the resolved ` s` conflict and the new progressive slide feature using `<! stop >` in slides.
Tech stack
python
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85