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

Documentation Update #1656

Merged
merged 1 commit into from
Mar 20, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/source/quick-start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ PostgreSQL Installation
sudo apt update
sudo apt upgrade
sudo apt install software-properties-common
sudo apt install python3-dev
sudo apt install postgresql postgresql-contrib postgresql-client
sudo apt install build-essential

Expand Down Expand Up @@ -62,27 +63,29 @@ Python Virtual Environment Configuration

.. code-block:: bash

su - ubuntu
# make sure you are logged in as your own user (i.e. "sean")
git clone https://github.com/chaoss/augur.git
cd augur/
sudo apt install make
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get install python3-venv
python3 -m venv $HOME/.virtualenvs/augur_env
source $HOME/.virtualenvs/augur_env/bin/activate
sudo apt install python-pip-whl
sudo apt install python3-pip
sudo apt install pythonpy
python -m pip install --upgrade pip
make install-dev {Follow prompts. You will need database credentials, a file location for cloned repositories, a GitHub Token, and a GitLab token.}

- Load a sample set of repositories. This can be accomplished through the Augur Command Line Interface (CLI). You can see available commands using
- Seven sample repositories are loaded by default. You can delete them if you want to use your own repositories by deleting the records from the `repo` table first, then deleting the records from the `repo_groups` table.

.. code-block:: bash

augur --help
augur db --help
augur backend --help

Loading Repositories
~~~~~~~~~~~~~~~~~~~~~~~~
The commands for loading repos are:

.. code-block:: bash
Expand Down