diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..f36cbd0fa63ce15e147010f8c4336b221dd96b8c --- /dev/null +++ b/README.md @@ -0,0 +1,69 @@ +# Log + +Log (diglog + analog) is a graphical environment for entering circuit schematics, and for analog +and digital circuit simulation. Please see [log/README](log/README) for more information. + +This is a fork of a part of the [Chipmunk +Distribution](https://john-lazzaro.github.io/chipmunk/pickup/pickup.html) +last maintained by [John Lazzaro](https://github.com/john-lazzaro). + +This repo has for goal to get rid of old code and make the rest +compliant with modern practices, protocols, frameworks and operating systems/architectures. + +Later on, we might add new features. + +## Compilation instructions + +### Dependencies + +For Debian : + +* `libx11-dev` +* `build-essential` + +### On Linux systems + +You may need to use [this patch](https://ar1.se/GuO0RElRWT) on x86_64 archiectures or [this one](https://github.com/erebstock/diglog-install/blob/master/diglog32.patch) on i686 architectures. + +Then just type : + +``` +$ make +``` + +## Tests + +_Not yet implemented_ + +## Static analysis + +_Not yet implemented_ + +## Codestyle checks + +_Not yet implemented_ + +## License + +``` +"DigLOG", the digital simulator for LOG. +Copyright (C) 1985, 1990 David Gillespie. +Author's address: daveg@synaptics.edu + +"AnaLOG", the analog simulator for LOG, 5.66 +Copyright (C) 1985, 1990 John Lazzaro. +Author's address: lazzaro@cs.berkeley.edu; + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation (any version). + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; see the file COPYING. If not, write to +the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +```