Skip to content

Commit 2168bc9

Browse files
committed
README: explain functionality, and add section about building from releases
1 parent 9ba81e3 commit 2168bc9

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,23 @@
11
MacGeiger - a WIFI AP locator utility
22
=====================================
33

4+
this tool puts your wireless card into monitor mode, then processes beacon
5+
frames from APs to create a list, in which you can navigate with the cursor
6+
keys, then select one AP with `ENTER`. the AP will open in detail view and
7+
start to beep. the faster it beeps, the better is the signal of the AP.
8+
9+
this is quite handy to adjust directional antennas for the perfect signal
10+
without having to stare at a screen, which may be impractical.
11+
12+
it can also be used on a mobile linux device (think netbook) to move through
13+
the streets and find the physical location of APs. you probably should wear
14+
headphones to do so...
15+
16+
the keys `+`/`-` and `0`/`9` can be used to adjust the audio volume.
17+
18+
Dependencies
19+
------------
20+
421
3rd party dependencies (install them including headers, i.e. -dev package)
522
- libpcap :packet capturing library
623
- libao :audio output library
@@ -11,8 +28,20 @@ MacGeiger - a WIFI AP locator utility
1128
- concol :terminal library with ncurses,termbox and SDL backends
1229
- depends on either SDL or ncurses devel package installed
1330

14-
how to build:
15-
-------------
31+
how to build from release tarball:
32+
----------------------------------
33+
34+
just run `make`. if you need to change variables, CFLAGS, etc, do so by
35+
creating a file called `config.mak' and override the settings there.
36+
you may also use it to change `BACKEND` to `SDL`.
37+
by default the ncurses version will be built since it is assumed it is more
38+
widely available.
39+
40+
Note: you may find release tarballs attached to git tags in the github repo.
41+
42+
how to build from git:
43+
----------------------
44+
1645
paste this into your shell
1746

1847
mkdir /tmp/macgeiger-build
@@ -26,6 +55,9 @@ paste this into your shell
2655
if you want to use the ncurses backend (which is much harder to debug using gdb),
2756
replace SDL_CONSOLE with NCURSES_CONSOLE in the above printf command
2857

58+
alternatively you may use the `create-dist` script to create a source tarball
59+
that does not require the rcb build tool.
60+
2961
rebuilding with a different console backend:
3062
-------------------------------------------
3163
if you decided to try another backend (not the previously used one), run

0 commit comments

Comments
 (0)