tweak README

Most importantly, mention 'python3 setup.py'.

Tweak indenting and some wording.

Change-Id: Id8c277de280b54d04edcafa77ed93017d6da473d
changes/98/14698/1
Neels Hofmeyr 4 years ago
parent ee9f2e211b
commit ff0607cbf7
  1. 20
      README

@ -1,11 +1,20 @@
Building/installation:
sudo python setup.py install
sudo python setup.py install
sudo python3 setup.py install
If you prefer to have it cleanly removable, install checkinstall and run
sudo checkinstall python setup.py install
Alternatively, just run 'pip install --user -e ./' or 'pip3 install --user -e ./'
sudo checkinstall python setup.py install
Alternatively, just run
pip install --user -e ./
pip3 install --user -e ./
depending on your python version.
Use
Use:
There are currently following scripts in this package:
osmotestconfig.py - test that apps start/write with example configs
soap.py - implementation of SOAP <-> Ctrl proxy implemented on top of Twisted (deprecated, unmaintained)
@ -20,8 +29,9 @@ twisted_ipa.py - implementation of IPA and Ctrl protocols on top of Twisted fram
osmodumpdoc.py - dump documentation, superseded by osmo_interact_vty.py -X
osmotestvty.py - test vty operations, superseded by osmo_verify_transcript_vty.py
Each of these scripts imports a project-specific osmoappdesc.py,
Some of these scripts import a project-specific osmoappdesc.py,
which provides information about the available apps, configs, vty ports, etc.
and is provided by other source trees (like osmo-bsc.git, osmo-msc.git, ...)
Run the scripts with osmoappdesc.py in the current directory (preferred)
or with -p <the directory containing osmoappdesc.py>.

Loading…
Cancel
Save