Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Updating the readme to give more specific dev guidelines :)
  • Loading branch information
astronomerritt authored Feb 16, 2024
1 parent cef7725 commit bdc0ace
Showing 1 changed file with 20 additions and 8 deletions.
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,11 @@
This project was automatically generated using the LINCC-Frameworks
[python-project-template](https://github.com/lincc-frameworks/python-project-template).

A repository badge was added to show that this project uses the python-project-template, however it's up to
you whether or not you'd like to display it!

For more information about the project template see the
[documentation](https://lincc-ppt.readthedocs.io/en/latest/).

## Dev Guide - Getting Started

Before installing any dependencies or writing code, it's a great idea to create a
virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual
environments. If you have conda installed locally, you can run the following to
virtual environment. If you have conda installed locally, you can run the following to
create and activate a new environment.

```
Expand All @@ -30,14 +24,32 @@ create and activate a new environment.
```

Once you have created a new environment, you can install this project for local
development using the following commands:
development using the following commands from within the adler folder:

```
>> pip install -e .'[dev]'
>> pre-commit install
```

**WARNING:** If you're installing on the RSP, then use the following pip command instead:

```
>> pip install --user -e .'[dev]'
```

If you're also working on the docs:

```
>> conda install pandoc
```

You can then test that everything works by running:

```
adler -s 8268570668335894776
```
This currently prints a friendly message to the terminal.

Notes:
1) The single quotes around `'[dev]'` may not be required for your operating system.
2) `pre-commit install` will initialize pre-commit for this local repository, so
Expand Down

0 comments on commit bdc0ace

Please sign in to comment.