annotate README @ 15:a24f0794ab4d default tip

INSTALL: document the new way
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 21 May 2024 00:29:21 +0000
parents 1ebc312f4b69
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 Themyscira Wireless system software (server-side software, add-ons to Osmocom
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 CNI suite) is being split into two principal domains:
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 themwi-csw will be the suite for circuit-switched calls (initially just voice,
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 but later CSD too), mostly unchanged from OsmoDevCall 2023-09-20 presentation;
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 themwi-smsc will be the SMSC for Themyscira Wireless, connecting to Osmocom GSM
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8 network via GSUP and to the outside world via SMPP.
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10 The one piece which is common between these two domains is the database of
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 locally owned phone numbers per North American Numbering Plan (NANP): whether
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 the task at hand is routing a call or routing SMS, either way we need to be able
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
13 to look at a phone number and immediately tell (without querying another server
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14 or process) if that number belongs in the local fiefdom or in the outside world.
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 Because the set of NANP telephone numbers which belong in the local fiefdom is
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 the same across different service types, the number database is shared between
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 the two domains - and the easiest way to share this database is to factor out
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 and share the code that implements it.
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
19
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
20 The present themwi-nanp package implements the number database part of ThemWi
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
21 and nothing else. It provides administration utilities, as well as libraries
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
22 and header files that will be used by both themwi-csw and themwi-smsc; the
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
23 present package needs to be compiled and installed before the other two.
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
24
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
25 In a departure from other Falconian software, some work has been done to
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
26 harmonize the dialect of C language with that used by Osmocom. The present
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
27 suite of software (themwi-*) is unusual in that it has no function by itself,
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
28 its only function is to serve as an add-on to Osmocom CNI suite - hence it is
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 desirable to have as much harmonization as possible between the base and the
1ebc312f4b69 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30 add-on.