mirroring
/
logisim
mirror of https://github.com/lawrancej/logisim.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Merge branch 'readme'

This commit is contained in:
Nick Allevato 2014-01-23 15:25:01 -05:00
parent b253d165d4 f69f1b216e
commit 5b9ccde625
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -3,7 +3,7 @@
Logisim is a circuit simulator, [originally available here](http://ozark.hendrix.edu/~burch/logisim/).
## Why this fork of Logisim?
Carl Burch, the original author of Logisim, abandoned development in 2011 and moved on to a similar successor project, [Toves](http://www.toves.org/) in 2013, because Logisim's code base is in need of a major overhaul. Rather than start from scratch ([something you should never do](http://www.joelonsoftware.com/articles/fog0000000069.html)), this fork of Logisim picks up where Dr. Burch left off to improve Logisim incrementally.
Carl Burch, the original author of Logisim, abandoned development in 2011 and moved on to a similar successor project, [Toves](http://www.toves.org/) in 2013, because Logisim's code base is in need of a major overhaul. Rather than start from scratch ([something you should never do](http://www.joelonsoftware.com/articles/fog0000000069.html)), this fork of Logisim picks up where Dr. Burch left off to incrementally improve Logisim.
## What's wrong with Logisim?
Logisim's code itself has numerous smells. Here's an incomplete list of these:
@ -12,13 +12,13 @@ Logisim's code itself has numerous smells. Here's an incomplete list of these:
* Undocumented packages, classes, methods
* Duplicated and dead code
* No coherent organization (it should be MVC)
* High coupling, low cohesion (it would benefit from IoC).
* High coupling, low cohesion (it would benefit from IoC)
* Unnecessarily reimplements functionality found in standard or third party libraries (e.g., it has it's own Toolbar classes)
* Code to draw components is too low-level
Logisim's user interface has numerous gotchas that need to be addressed. Here's some of the more important issues:
* The file format is not merge-friendly, making it impossible for students to collaborate on circuits.
* The file format is not merge-friendly, making it impossible for students to collaborate on circuits
* Unreasonable defaults
* Limited interaction styles
* Single (graphical) view of circuit
@ -27,7 +27,7 @@ Logisim's user interface has numerous gotchas that need to be addressed. Here's
It is arguably the best free tool for teaching circuit design, which is why its development must continue.
## Getting started for developers
Logisim developers: Logisim uses the [Gradle build system](http://www.gradle.org), so set that up first before attempting to develop Logisim. Ensure that the gradle executable is in the system path. To build the executable for Windows, you must install [launch4j](http://launch4j.sourceforge.net/) and ensure it is on the system path.
Logisim developers: Logisim uses the [Gradle build system](http://www.gradle.org), so set that up first before attempting to develop Logisim. Ensure that the gradle executable is in the system path. To build the executable for Windows, you must install [launch4j](http://launch4j.sourceforge.net/) and ensure it is in the system path.
The build script recognizes the following commands: