@@ -8,6 +8,13 @@ This editor was created as a personal project for learning C++.
88
99That being said, it * will* find a way to break so don't edit anything you actually need with it.
1010
11+ ## Prerequisites
12+
13+ - C++17 compatible compiler (GCC 7+, Clang 5+, MSVC 2017+)
14+ - CMake 3.10 or higher
15+ - Make or Ninja build system
16+ - Unix-like operating system (Linux, macOS)
17+
1118## Configuring
1219
1320Qedit includes a configuration system that parses ` ~/.qeditrc ` by default.
@@ -43,11 +50,27 @@ Or, use the build script via:
4350./build.sh --release
4451```
4552
53+ ### Optional
54+ Add an alias to your shell configuration:
55+ ``` bash
56+ # For bash users (add to ~/.bashrc):
57+ echo " alias qedit=\" $( pwd) /build/Qedit\" " >> ~ /.bashrc
58+ source ~ /.bashrc
59+
60+ # For zsh users (add to ~/.zshrc):
61+ echo " alias qedit=\" $( pwd) /build/Qedit\" " >> ~ /.zshrc
62+ source ~ /.zshrc
63+
64+ # For fish users (add to ~/.config/fish/config.fish):
65+ echo " alias qedit=\" $( pwd) /build/Qedit\" " >> ~ /.config/fish/config.fish
66+ source ~ /.config/fish/config.fish
67+ ```
68+
4669## Testing
4770
4871Qedit uses the Catch2 Testing Framework for unit tests. There are two ways to run the tests:
4972
50- 1 . Using CMake's test runner:
73+ Using CMake's test runner:
5174``` bash
5275cd build
5376cmake ..
5780ctest --output-on-failure
5881```
5982
60- 2 . Running individual test executables:
83+ Running individual test executables:
6184``` bash
6285# Run all editor tests
6386./build/editor_test -d yes
0 commit comments