Improve readability

This commit is contained in:
xypwn 2020-03-24 20:38:24 +01:00
parent e2af8a32d2
commit af92f48c36

View File

@ -6,18 +6,25 @@
- 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:
$`./CircuitSimulator` $`./CircuitSimulator`
### Notes ### ### Notes ###
- The software is currently under heavy development and therefore still crawling with bugs - The software is currently under heavy development and therefore still crawling with bugs