logisim-evolution/logisim-evolution

Documentation

Open

#303 opened on Dec 17, 2019

View on GitHub
 (16 comments) (0 reactions) (0 assignees)Java (505 forks)batch import
documentationhelp wantedpri +1

Repository metrics

Stars
 (3,695 stars)
PR merge metrics
 (Avg merge 3d 18h) (47 merged PRs in 30d)

Description

Hmmm, I also have to blame myself, but the current help system is out of date and needs some handling. Maybe a first step could be to first attack on the English version and than go to the other languages. Many new features are not/partly documented and make the use of logisim a lot easier to the targeted public, when documented. It would be great if we could maintain Carl Burch's standard of documentation; who wants to help?

Contributor guide

Research direction
Help update the documentation, starting with the English version and then translating to other languages. Focus on new features that are not yet documented.
Tech stack
java
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.
Half day
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.
70