Skip to content

Commit 550d6a5

Browse files
committed
Update README.md.
1 parent 5963034 commit 550d6a5

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

README.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -16,46 +16,47 @@ A simple Linux/X11 VT220 terminal emulator featuring:
1616

1717
# Quickstart #
1818

19-
Build terminol (this requires pcre, xkbcommon, xcb, pango, cairo and a C++11 compiler).
19+
Obtain the terminol source code, either by downloading and unpacking a package file,
20+
or by cloning the repository:
2021

21-
./configure ./build-dir debug gnu
22-
cd build-dir
22+
git clone https://github.com/bagnose/terminol.git
23+
cd terminol
24+
25+
Build terminol (this requires pcre, xkbcommon, xcb, pango, cairo and a C++11 compiler):
26+
27+
# Establish a debug/GCC build directory (run 'configure' without any arguments
28+
# to see other options):
29+
./configure ../terminol-debug-gnu debug gnu
30+
cd ../terminol-debug-gnu
2331
make
2432

2533
Create a configuration file (see doc/sample-config).
2634
At the bare minimum you need to specify the font:
2735

28-
mkdir ~/.config/terminol
36+
mkdir -p ~/.config/terminol
2937
cat << EOF > ~/.config/terminol/config
3038
set font-name "Meslo LG M"
3139
set font-size 14
3240
EOF
3341

34-
Launch terminol
42+
Launch terminol:
3543

3644
# Launch a standalone window:
3745
./dist/bin/terminol
3846

39-
# or launch the server/daemon
47+
# or launch the server/daemon:
4048
./dist/bin/terminols
4149

4250
# and start windows with:
4351
./dist/bin/terminolc
4452

45-
Install terminol
53+
Install terminol:
4654

55+
# This will copy the terminol binaries into ${INSTALLDIR}/bin:
4756
make INSTALLDIR=/usr/local install
4857

49-
# TODO #
58+
# Upcoming Features #
5059

5160
- highlighting and actions for user defined (regex) patterns
5261

5362
- reverse search
54-
55-
# FAQ #
56-
57-
* Why another terminal emulator?
58-
59-
* How do I write a config file?
60-
61-
See the annotated doc/sample-config

0 commit comments

Comments
 (0)