Skip to content

Commit

Permalink
add install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
arjunsavel authored Dec 5, 2023
1 parent 6c68f22 commit 402cf9e
Showing 1 changed file with 16 additions and 5 deletions.
21 changes: 16 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,19 @@
so far: what you need to do is...pip install astrodbtoolkit.
astrotemplate-db
---------------------------
A template for astronomical databases.

pip install git+https://github.com/dr-rodriguez/AstrodbKit2
installation instructions
---------------------------
All you should need to run is:

`pip install .`

will check later what we need for the environment file? or...actually,
let's start with the current environment file and prune what we don't need later
on the tests.
If you'd liek to ensure that the package has been installed correctly, you can run

`pip install .[test]`

then run

`pytest tests`

These commands will download the `pytest` package and run this codebase's test suite, respectively.

0 comments on commit 402cf9e

Please sign in to comment.