Maintenance scheduled for Thursday, September 24th at 15:00 MDT. Expected downtime <1 hour.

Updated numbering

parent 524e9408
# Setting up the development environment on Windows
## 2. Download and install Git
## 1 Download and install Git
Git is a source control manager. It tracks changes made to the code and helps
to keep versions of the code organized.
......@@ -9,7 +9,7 @@ to keep versions of the code organized.
This does not require administrative privileges.
**Do not** install Git for all users.
## 3. Create an SSH key and add it to your GitLab account
## 2. Create an SSH key and add it to your GitLab account
In order to securely communicate with the remote repository server, you'll need
to set up SSH.
......@@ -31,7 +31,7 @@ Follow the instructions under **Generating a new SSH key pair** and
ssh -T git@code.usgs.gov
```
## 4. Clone the repository
## 3. Clone the repository
Cloning the repository downloads a copy of the Git repository to your
local machine. This repository contains a history of changes, and most
......@@ -51,7 +51,7 @@ C:\Users\user>cd path-to-sources
C:\path-to-sources>git clone git@code.usgs.gov:FluEgg/fluegg.git
```
## 5. Create and activate the fluegg venv environment
## 4. Create and activate the fluegg venv environment
In this step, you will create a venv environment that contains the version
of Python and versions of packages that are known to work with the FluEgg code
......@@ -79,7 +79,7 @@ C:\path-to-sources\fluegg>env\Scripts\activate
(env) C:\path-to-sources\fluegg>
```
## 6. Install the fluegg environment
## 5. Install the fluegg environment
The fluegg environment contains Python packages that the fluegg package is
known to work with.
......@@ -90,7 +90,7 @@ First, install the packages in the environment using pip.
(env) C:\path-to-sources\fluegg>pip install -r requirements.txt
```
## 7. Install the fluegg package
## 6. Install the fluegg package
In order for the Python interpreter in the fluegg environment to have "global"
access to the fluegg package, you'll have to install the package within the
......@@ -104,7 +104,7 @@ fluegg environment.
The `-e` option tells pip to install the fluegg package in "editable" mode.
See ["Editable" installs](https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs) for more info.
## 8. Run the FluEgg unit tests
## 7. Run the FluEgg unit tests
Running the unit tests will ensure the environment is set up and the FluEgg
code is working correctly.
......@@ -125,7 +125,7 @@ OK
The tests passing is a clear indicator that the FluEgg environment has been set
up correctly. You're ready to begin working with the code.
## 9. Build the code documentation
## 8. Build the code documentation
Currently, only the docstrings within the FluEgg code are available in the
documentation.
......@@ -145,7 +145,7 @@ To view the generated HTML documentation, open the file
`path-to-sources\fluegg` is the top-level directory of the FluEgg project on
your machine.
## 10. Build an executable
## 9. Build an executable
The FluEgg repository also contains code for the user interface. This user interface
may be tested by running the following command:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment