diff options
| -rw-r--r-- | Documentation/user-manual.txt | 32 | ||||
| -rw-r--r-- | Documentation/user-manual_es.txt | 36 |
2 files changed, 43 insertions, 25 deletions
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt index 02379fe18..6d3ac4d8e 100644 --- a/Documentation/user-manual.txt +++ b/Documentation/user-manual.txt @@ -1105,9 +1105,13 @@ using Microsoft Access databases, preventing the integration the importer into t core application. A stand alone tool for Linux has been developed to import the _.slg_ files -generated by SmartTrak to Subsurface's _.xml_ format. It can be built together -with _Subsurface_ for Linux systems. Two dependencies need to be installed in -your system before building: _libglib2.0_ and _libmdb2_. +generated by SmartTrak to Subsurface's _.xml_ format. It can be downloaded +from https://subsurface-divelog.org/downloads[the usual _Subsurface_ repository], +as a Windows installer or a Linux AppImage. +The application is not currently supported on Mac. + +It can also be built for Linux systems. Two dependencies need to be met in your +system before building: _glib2.0_ and _mdbtools_ (see below). In addition, a web service is available for divelog convertions from SmartTrak to _Subsurface_ (see below). @@ -1119,15 +1123,19 @@ for assistance in importing _SmartTrak_ dive logs. Assuming the above dependencies have been installed and the _Subsurface_ source tree is in the directory _~/src/subsurface_, then: -- Move to the source tree directory. -- Run " $ ccmake build " and set SMARTTRAK_IMPORT option to *on* (off by - default). -- Generate with [c] and save and exit with [g]. -- Build as you prefer, using the _build.sh_ script (recomended) or moving to build - directory and running _make_. -- After a successful build, there will be an executable named _smtk2ssrf_ in the - _subsurface/build_ directory. - Copy or move it to a directory in your $PATH, e.g. _~/bin_. +- Move to the source tree directory out of _Subsurface_ (e.g. ~/src) +- Run " $ ./subsurface/scripts/smtk2ssrf-build.sh ", if every thing has gone + fine, you will now have an executable named smtk2ssrf in + ~/src/subsurface/smtk-import/build +- You can run it from this directory, copy it to another one, e.g. _~/bin_ or + simply run "sudo make install", and the binary will be installed in + /usr/local/bin (which is commonly included in every $PATH). +- The script has some options mostly useful for development pourposes. If you + think you may need them, please read comments on script header itself. +- *WARNING*: While building smtk2ssrf, a light version of _Subsurface_ is + built (usable but lacking a lot of features). So, if you commonly use the + built executable placed at ~/subsurface/build/, you will need to rebuild it as + explained in this manual above. ===== Running diff --git a/Documentation/user-manual_es.txt b/Documentation/user-manual_es.txt index 38b8b0b04..6ff52e7a8 100644 --- a/Documentation/user-manual_es.txt +++ b/Documentation/user-manual_es.txt @@ -1135,8 +1135,12 @@ otros. Se ha desarrollado una pequeña herramienta independiente para importar los archivos .slg generados por SmartTrak al formato .xml de _Subsurface_. Puede -compilarse junto con _Subsurface_ en sistemas Linux. Se necesita instalar dos -dependencias antes compilar: libglib2.0 y libmdb2. +descargarse desde https://subsurface-divelog.org/downloads[el repositorio habitual de _Subsurface_], +como instalador para Windows, o como AppImage para Linux. +Actualmente la aplicación no está soportada en Mac. + +También puede compilarse en sistemas Linux. Se necesita instalar dos +dependencias antes de compilar: _glib2.0_ y _mdbtools_ (ver a continuación). Además, está disponible un servicio web para convertir divelogs desde SmartTrak a _Subsurface_ (ver a continuación). @@ -1144,20 +1148,26 @@ SmartTrak a _Subsurface_ (ver a continuación). Si necesitas ayuda puedes contactar con el equipo de _Subsurface_ en mailto:subsurface@subsurface-divelog.org[nuestra lista de correo] +===== Compilar _smtk2ssrf_ + Suponiendo que se hayan instalado las dependencias y que el directorio raíz del código de _Subsurface_ sea ~/src/subsurface, entonces: -===== Compilar _smtk2ssrf_ - -- Sitúate en el directorio raíz del código de _Subsurface_ -- Ejecuta " $ ccmake build " y ajusta la opción SMARTTRAK_IMPORT a *ON* (por - defecto en OFF). -- Selecciona [c] y [g] para generar la configuración de cmake y guardarla. -- Compila el código como prefieras, usando el script build.sh (recomendado) o - yendo al directorio "build" y ejecutando "make". -- Si se ha compilado el código con éxito, habrá un ejecutable en el directorio - "build" llamado smtk2ssrf, cópialo o muévelo a un directorio que se - encuentre incluido en tu $PATH, p.e. ~/bin +- Sitúate en el directorio raíz del código, fuera de _Subsurface_ (~/src en el + ejemplo) +- Ejecuta " $ ./subsurface/scripts/smtk2ssrf-build.sh " y, si todo va bien, + obtendrás un binario ejecutable en la carpeta + ~/src/subsurface/smtk-import/build +- Puedes ejecutarlo desde allí, copiarlo a una carpeta que esté en tu $PATH o + moverte allí y correr "$ sudo make install" que. por defecto lo instalará en + /usr/local/bin, el cual suele estar incluido en el $PATH +- El script tiene algunas opciones de ejecución en línea de comandos útiles + mayormente para desarrollo, si crees que puedes necesitarlas, por favor, lee + el encabezamiento del script. +- *AVISO*: Al compilar smtk2ssrf, se recompila una versión aligerada de + _Subsurface_. Esto carecerá de importancia excepto si utilizas habitualmente + el binario compilado previamente que se encuentra en ~/src/subsurface/build. + En ese caso tendrás que recompilar _Subsurface_. ===== Ejecutar |