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.

Sign up for GitHub

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

Jump to bottom

Quickstart guide #2599

Merged
merged 2 commits into from
Jul 7, 2023
Merged

Quickstart guide #2599

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cd6b6b0
Added a quickstart guide
AlvesJorge Jul 4, 2023
3f438af
formatting
AlvesJorge Jul 4, 2023
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
20 changes: 20 additions & 0 deletions docs/user_guide.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,26 @@
User Guide
==========

Quick start
-----------
Create the environment (creates a folder in your current directory)
.. code-block:: console

virtualenv env_name
In Linux or Mac, activate the new python environment
.. code-block:: console

source env_name/bin/activate
Or in Windows
.. code-block:: console

.\env_name\Scripts\activate
Confirm that the env is successfully selected
.. code-block:: console

which python3


Introduction
------------

Expand Down