瀏覽代碼

Docs: Added installation instructions.

Lacey Sanderson 6 年之前
父節點
當前提交
15fe6da980
共有 4 個文件被更改,包括 32 次插入0 次删除
  1. 8 0
      docs/index.rst
  2. 9 0
      docs/install.rst
  3. 二進制
      docs/install/tripal_jbrowse.1.install.png
  4. 15 0
      docs/install/tripal_jbrowse.rst

+ 8 - 0
docs/index.rst

@@ -2,8 +2,16 @@
 Tripal JBrowse Documentation
 =============================
 
+This package of modules integrates `GMOD JBrowse <https://jbrowse.org/>`_ into your `Tripal <http://tripal.info/>`_ site providing
+
+   - Tripal page integration via **Tripal JBrowse** and
+   - a user interface for JBrowse instance creation and management via **Tripal JBrowse Management**.
+
+ This powerful combination allows you to provide seamless genome browsing to your users in an administrator-friendly manner.
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   install
    tripal_jbrowse

+ 9 - 0
docs/install.rst

@@ -0,0 +1,9 @@
+
+Installation
+=============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   install/tripal_jbrowse

二進制
docs/install/tripal_jbrowse.1.install.png


+ 15 - 0
docs/install/tripal_jbrowse.rst

@@ -0,0 +1,15 @@
+
+Tripal JBrowse Installation
+============================
+
+This module is available for download from github.com/tripal/tripal_jbrowse.
+
+1. Download and upack the module into ``[DRUPAL ROOT]/sites/all/modules`` where ``DRUPAL_ROOT`` is the path to your drupal site.
+2. Navigate to ``https://yourdrupalsite.com/admin/modules`` or click **Administration Toolbar > Modules**
+3. Scroll to **Tripal Extensions**, click the checkbox beside "Tripal-JBrowse Integration", and click the "Save Configuration" button at the bottom of the page.
+
+.. image:: tripal_jbrowse.1.install.png
+
+.. note::
+
+   This module is dependant upon the **Link** module. It is not mentioned above in the install instructions since you should already have installed it when installing Tripal.