r4
/
circuit-logic-simulator
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Improve readability

This commit is contained in:
xypwn 2020-03-24 20:40:36 +01:00
parent eba508c679
commit de9e38ddf7
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,27 +1,27 @@
# Circuit Logic Simulator # # Circuit Logic Simulator #
### Build Instructions ### ### Build Instructions ###
1. **Install dependencies:** 1. **Install dependencies**
- Qt base: `qt5-base` - Qt base: `qt5-base`
- QMake: `qt5-tools` - QMake: `qt5-tools`
- Compiler: `g++` or `clang`, must support C++ 11 or later - 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. - Note that your distro's package names might vary. All provided package names are those used by Archlinux.
2. **Clone the repository and cd into it:** 2. **Clone the repository and cd into it**
$`git clone https://github.com/xypwn/circuit-logic-simulator.git` $`git clone https://github.com/xypwn/circuit-logic-simulator.git`
$`cd circuit-logic-simulator` $`cd circuit-logic-simulator`
3. **Create a build directory and cd into it:** 3. **Create a build directory and cd into it**
$`mkdir build` $`mkdir build`
$`cd build` $`cd build`
4. **Configure build using QMake:** 4. **Configure build using QMake**
$`qmake ..` $`qmake ..`
5. **Start build (replace 4 with the number of threads you have to speed it up)** 5. **Start build (replace 4 with the number of threads you have to speed it up)**
$`make -j 4` $`make -j 4`
6. **Run the executable:** 6. **Run the executable**
There should now be an executable file called `CircuitSimulator` in your There should now be an executable file called `CircuitSimulator` in your
build folder. You can put it anywhere or run it with: build folder. You can put it anywhere or run it with: