Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation on first time use #1648

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Binary file added docs/images/first_time.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
29 changes: 22 additions & 7 deletions docs/source/lab/installation.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
Installation
============

For detailed installation instructions and first-time setup, including
screenshots, visit our `open-teaching platform
<https://asreview.github.io/asreview-academy/ASReviewLAB.html>`_.

Install Python
--------------

ASReview requires Python 3.8 or later. Install Python following these
`instructions <https://www.python.org/downloads/>`__. Verify your
installation by typing the following in a command prompt (``CMD.exe`` on
Windows) or terminal (``Terminal`` on MacOS or Linux):

.. code:: bash

python --version

This command will display the installed version.


Install ASReview
----------------

ASReview software requires an installation of Python 3.8 or later. Detailed
step-by-step instructions to install Python (and ASReview) are available for
`Windows <https://asreview.ai/download>`__ and
`macOS/Linux <https://asreview.ai/download/>`__ users.

Install the ASReview software with Pip by running the following command in the
`CMD.exe` (Windows) or `Terminal` (MacOS/Linux):
To install ASReview LAB, users on Windows should open ``CMD.exe``. Those on
MacOS or Linux need to open ``Terminal``. Install ASReview LAB with Pip by
running the following command:

.. code:: bash

Expand Down
17 changes: 13 additions & 4 deletions docs/source/lab/start.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,24 @@
Start ASReview LAB
==================

After you install ASReview LAB, start the program via the command line to
start using it.
To start ASReview LAB, users on Windows should open ``CMD.exe`` and run the
ASReview LAB command. Those on MacOS or Linux need to open ``Terminal`` and
execute the same command. Detailed step-by-step instructions and screenshots
are available on our `open-teaching platform
<https://asreview.github.io/asreview-academy/ASReviewLAB.html>`_.

To start ASReview run:

.. code:: bash

asreview lab

When you are using Windows, open `CMD.exe` and run the command. When you use
MacOS or Linux, you can open `Terminal` and run the command.
Upon executing this command, ASReview LAB will initiate, and your default web
browser will automatically open a new tab to the ASReview LAB interface where
you can begin your systematic review.

.. figure:: ../../images/first_time.png
:alt: First time opening ASReview LAB

The information in the sections below is more advanced and not needed for the
majority of the ASReview LAB users.
Expand Down