Skip to content

Commit 367399c

Browse files
committed
Some Readme updates
1 parent 056c505 commit 367399c

1 file changed

Lines changed: 25 additions & 2 deletions

File tree

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,13 @@ This editor was created as a personal project for learning C++.
88

99
That 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

1320
Qedit 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

4871
Qedit 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
5275
cd build
5376
cmake ..
@@ -57,7 +80,7 @@ ctest
5780
ctest --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

Comments
 (0)