diff --git a/gui/wxpython/Makefile b/gui/wxpython/Makefile index b56e64ebaa5..b1785f75dc0 100644 --- a/gui/wxpython/Makefile +++ b/gui/wxpython/Makefile @@ -14,7 +14,7 @@ SRCFILES := $(wildcard icons/*.py xml/*) \ mapswipe/*.py modules/*.py nviz/*.py psmap/*.py rdigit/*.py \ rlisetup/*.py startup/*.py timeline/*.py vdigit/*.py \ vnet/*.py web_services/*.py wxplot/*.py iscatt/*.py tplot/*.py photo2image/*.py image2target/*.py) \ - wxgui.py README + wxgui.py README.md DSTFILES := $(patsubst %,$(DSTDIR)/%,$(SRCFILES)) \ $(patsubst %.py,$(DSTDIR)/%.pyc,$(filter %.py,$(SRCFILES))) diff --git a/gui/wxpython/README b/gui/wxpython/README deleted file mode 100644 index c88d3f63d2f..00000000000 --- a/gui/wxpython/README +++ /dev/null @@ -1,79 +0,0 @@ -GRASS GIS - wxPython Graphical User Interface (wxGUI) -===================================================== - -$Date$ - -1 - REQUIREMENTS - - GRASS GIS >= 6.4 - Python >= 2.4 - Python ElementTree (only for Python 2.4) - wxPython >= 2.8.10.1 - NumPy >= 1.0.4 - PIL >= 1.1.7 - - -2 - STARTUP WITH GRASS INITIALIZATION - -If you want to launch wxPython GUI automatically, start GRASS with -`--gui` parameter - -$ grass --gui - - -3 - STARTUP FROM GRASS TERMINAL - -Simply run - -$ g.gui wxpython - -from the GRASS terminal. - -You can also specify workspace file to load on startup. - -$ g.gui gui=wxpython workspace=myworkspace.gxw - - -4 - DEBUGGING - -To enable GUI debug messages on given level set WX_DEBUG environment -variable, e.g. - -$ g.gisenv set="WX_DEBUG=3" - - -5 - CLI BASED DISPLAY USAGE - -Use command d.mon (shell script in gui/scripts directory) to start map -display: - -GRASS> d.mon wx[0-6] - -After a while, new window should appear. If this is your case, add some -raster layer to the map display: - -GRASS> d.rast aspect - -And try the vector layer too - -GRASS> d.vect roads - -You should be able to zoom && pan through the map, once the layers are -displayed. You should be also able to store the display content as well as -clear the display and start from scratch. - - -6 TRANSLATION HANDLING - -Notes: -- Help part of menu entries is coming from the module descriptions -- The menu is maintained manually in xml/menudata.xml - -Update of module description strings in xml/menudata.xml: -- in a GRASS session, run tools/update_menudata.py - -From this (updated) xml/menudata.xml, the gettext strings are generated -via Makefile and stored into the file "menustrings.py". - -When generating the po files in locale/po/ but locale/Makefile, all -.py files are parsed and the strings are stored in locale/po/grasswxpy_XX.po diff --git a/gui/wxpython/README.md b/gui/wxpython/README.md new file mode 100644 index 00000000000..cf73dad8c66 --- /dev/null +++ b/gui/wxpython/README.md @@ -0,0 +1,69 @@ +# GRASS GIS - wxPython Graphical User Interface (wxGUI) + +## 1 - REQUIREMENTS + +See `[../../REQUIREMENTS.md](../../REQUIREMENTS.md)` + +## 2 - STARTUP WITH GRASS INITIALIZATION + +If you want to launch wxPython GUI automatically, start GRASS with +`--gui` parameter + +`$ grass --gui` + +## 3 - STARTUP FROM GRASS TERMINAL + +Simply run + +`$ g.gui wxpython` + +from the GRASS terminal. + +You can also specify workspace file to load on startup. + +`$ g.gui gui=wxpython workspace=myworkspace.gxw` + +## 4 - DEBUGGING + +To enable GUI debug messages on given level set `WX_DEBUG` environment +variable, e.g. + +`$ g.gisenv set="WX_DEBUG=3"` + +## 5 - CLI BASED DISPLAY USAGE + +Use command `d.mon` (shell script in `gui/scripts/` directory) to start map +display: + +`GRASS> d.mon wx[0-6]` + +After a while, new window should appear. If this is your case, you can now +add some layers, e.g. a raster layer to the map display: + +`GRASS> d.rast aspect` + +And try the vector layer, too + +`GRASS> d.vect roads` + +You should be able to zoom & pan through the map, once the layers are +displayed. You should be also able to store the display content as well as +clear the display and start from scratch. + +## 6 TRANSLATION HANDLING + +Notes: + +- Help part of menu entries is coming from the module descriptions +- The menu is generated by `./tools/build_modules_xml.py` + +Update of module description strings in `./xml/menudata.xml`: + +- in a GRASS session, run `./tools/update_menudata.py` + +From this (updated) `./xml/menudata.xml`, the gettext strings are generated +via Makefile and stored into the file `menustrings.py`. + +While generating the po files in `../../locale/po/` by `../../locale/Makefile`, +all `.py` files are parsed and the strings are stored in +`../../locale/po/grasswxpy_XX.po`.