annotate README @ 33:a91fb88a57b2 default tip

add INSTALL document
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 14 Jun 2024 20:29:17 +0000
parents 829e082793d0
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
32
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
1 The present suite consists of utilities for encoding and decoding SMS message
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
2 bodies and PDUs. On the decoding side, it includes sms-pdu-decode and
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
3 pcm-sms-decode utilities that were previously maintained as part of FreeCalypso
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
4 host tools: they now extend beyond FreeCalypso GSM MS into SIM card exploration
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
5 (fc-simtool) and network-side SMSC prototyping applications. On the encoding
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
6 side, there are two new programs described in doc/Generator-tool-summary and
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
7 doc/Generator-tool-workflow articles.
11
9ed03ed4e673 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8
32
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
9 Similarly to gsm-codec-lib, the present sms-coding-utils package stands between
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
10 FreeCalypso and Themyscira Wireless software realms: it has potential
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
11 applications on both the mobile side and the network side of GSM. It is
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
12 expected to be used together with any or all of the following software
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
13 components:
11
9ed03ed4e673 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14
32
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
15 * FreeCalypso host tools;
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
16 * FreeCalypso SIM tools;
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
17 * ThemWi proto-SMSC implementation used to exercise SMS-over-GSUP functionality
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
18 in Osmocom CNI suite.
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
19
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
20 However, even though the present sms-coding-utils suite is designed to be useful
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
21 with all of the above FC and ThemWi components, it does not depend on any of
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
22 them. The present package can be compiled and installed by itself (see INSTALL
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
23 document); all run-time interactions between these utilities and other software
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
24 happen through ASCII text files or pipes, or through binary files in externally
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
25 defined record format (GSM 11.11 spec and its successors) in the case of
829e082793d0 new README
Mychaela Falconia <falcon@freecalypso.org>
parents: 11
diff changeset
26 pcm-sms-decode.