Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mjoppich committed May 16, 2019
1 parent 6dbb624 commit a51de7a
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 0 deletions.
1 change: 1 addition & 0 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,7 @@ if (NOT APPLE)

file(GLOB biogui_templates
"${CMAKE_CURRENT_SOURCE_DIR}/templates/WSL_install.gui"
"${CMAKE_CURRENT_SOURCE_DIR}/templates/circlator_docker.gui"
)

install(DIRECTORY DESTINATION ${CMAKE_INSTALL_PREFIX}/install_templates)
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ The binary distribution (zip-files) are targeted for *end-users*: [prebuilt bina
After downloading the zip-archive, please unzip the archive to a location of your preference. Then simply start the executable (bioGUI.exe on Windows, or bioGUI on linux).

On Windows, please follow the steps on [how to setup WSL](http://biogui.readthedocs.io/en/latest/build_wsl.html).
Place bioGUI into a location which does not contain spaces in its name, e.g not C:\Program Files\bioGUI ! C:\bioGUI is fine though!

On any aptitude supported platform (Windows with WSL, Ubuntu), please download the "First Time Ubuntu/WSL/apt-get Setup" from the list of available templates and install it via *Install Template Module* (install program: *First Time Ubuntu/WSL/apt-get setup*).
For Mac OS, please execute download and execute *First Time Mac OS Setup*.
Expand Down
Binary file added doc/images/template_usage/setup_1.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/template_usage/setup_2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/template_usage/setup_3.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions doc/user_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Make sure that the Windows Subsystem for Linux (WSL) is installed.
Please follow the steps on [how to setup WSL](http://biogui.readthedocs.io/en/latest/build_wsl.html).

After downloading the zip-archive, please unzip the archive to a location of your preference. Then simply start the executable (bioGUI.exe on Windows).
*Place bioGUI into a location which does not contain spaces in its name, e.g not C:\Program Files\bioGUI !* C:\bioGUI is fine though!

On any aptitude supported platform (e.g. Windows with WSL, Ubuntu), please download the "First Time Ubuntu/WSL/apt-get Setup" from the list of available templates and install it via *Install Template Module* (install program: *First Time Ubuntu/WSL/apt-get setup*).

Expand All @@ -84,15 +85,36 @@ Below this process is shown by an animation.
Setup First Time Use
--------------------

For the *First Time Use* setups, please make sure to insert your *sudo/user* password and deselect to save a template.

.. image:: ./images/bioGUI_wsl_setup.gif
:scale: 50

Please make sure that bioGUI closes the setup with the following message:

.. image:: ./images/template_usage/setup_1.png
:scale: 100

If you do not see this message, (`raise an issue on GitHub <https://github.com/mjoppich/bioGUI/issues/>`_) with attaching the *log.txt* file in the bioGUI folder, or */tmp/log_biogui.txt* on Mac OS, as well as an screenshot of the attempt.

Install an install module
-------------------------

.. image:: ./images/bioGUI_graphmap.gif
:scale: 50

After the install module has been installed, you will see a message stating that *bioGUI* installed the software:

.. image:: ./images/template_usage/setup_3.png
:scale: 100

If you do not see the message, but only blue text, like below, you need to scroll up:

.. image:: ./images/template_usage/setup_2.png
:scale: 100

If you do not see this message, (`raise an issue on GitHub <https://github.com/mjoppich/bioGUI/issues/>`_) with attaching the *log.txt* file in the bioGUI folder, or */tmp/log_biogui.txt* on Mac OS, as well as an screenshot of the attempt.

Use an Install Module
---------------------

Expand Down

0 comments on commit a51de7a

Please sign in to comment.