circuit-logic-simulator/README.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

2020-03-24 20:18:39 +01:00
# Circuit Logic Simulator #
### Build Instructions ###
2020-03-24 20:40:36 +01:00
1. **Install dependencies**
2020-03-24 20:18:39 +01:00
- Qt base: `qt5-base`
- QMake: `qt5-tools`
2020-03-24 20:28:02 +01:00
- Compiler: `g++` or `clang`, must support C++ 11 or later
- Note that your distro's package names might vary. All provided package names are those used by Archlinux.
2020-03-24 20:40:36 +01:00
2. **Clone the repository and cd into it**
2020-03-24 20:38:24 +01:00
2020-03-24 20:18:39 +01:00
$`git clone https://github.com/xypwn/circuit-logic-simulator.git`
2020-03-24 20:38:24 +01:00
2020-03-24 20:18:39 +01:00
$`cd circuit-logic-simulator`
2020-03-24 20:40:36 +01:00
3. **Create a build directory and cd into it**
2020-03-24 20:38:24 +01:00
2020-03-24 20:18:39 +01:00
$`mkdir build`
2020-03-24 20:38:24 +01:00
2020-03-24 20:18:39 +01:00
$`cd build`
2020-03-24 20:40:36 +01:00
4. **Configure build using QMake**
2020-03-24 20:38:24 +01:00
2020-03-24 20:18:39 +01:00
$`qmake ..`
5. **Start build (replace 4 with the number of threads you have to speed it up)**
2020-03-24 20:38:24 +01:00
2020-03-24 20:18:39 +01:00
$`make -j 4`
2020-03-24 20:40:36 +01:00
6. **Run the executable**
2020-03-24 20:39:30 +01:00
2020-03-24 20:18:39 +01:00
There should now be an executable file called `CircuitSimulator` in your
build folder. You can put it anywhere or run it with:
2020-03-24 20:38:24 +01:00
2020-03-24 20:18:39 +01:00
$`./CircuitSimulator`
### Notes ###
- The software is currently under heavy development and therefore still crawling with bugs
- The `About` and `Tutorial` menu item haven't yet been implemented
2020-03-24 20:28:02 +01:00
- Although some icons are missing, you can hover over an item to see what it does