Skip to content

Commit

Permalink
Fixes README to install the server dependencies
Browse files Browse the repository at this point in the history
Also notes that this is not needed for the full thing.
  • Loading branch information
elijahbenizzy committed Feb 23, 2024
1 parent 7de8a97 commit e4da2f5
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 7 deletions.
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,21 +41,24 @@ but realized that it has a wide array of applications and decided to release it.

To get started, install from `pypi`, using your favorite package manager:

```
pip install burr
```bash
pip install "burr[start]"
```

This includes the dependencies for the tracking server (see next step) -- alternatively if you want the core library only then just run `pip install burr`
Then, run the server and check out the demo projects:

```
burr
```bash
$ burr

2024-02-23 11:43:21.249 | INFO | burr.cli.__main__:run_server:88 - Starting server on port 7241
```

This will open up a browser window with a few demo projects preloaded for you to play with.
This will start a server and open up a browser window with a few demo projects preloaded for you to play with.

Next, see the documentation for [getting started](https://studious-spork-n8kznlw.pages.github.io/getting_started/simple-example.html), and follow the example.
Then read through some of the concepts and write your own application!

# Contributing

We welcome contributors! To get started on developing, see the [developer-facing docs]([documentation](https://studious-spork-n8kznlw.pages.github.io/contributing))_
We welcome contributors! To get started on developing, see the [developer-facing docs](https://studious-spork-n8kznlw.pages.github.io/contributing).
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,17 @@ tracking = [
"loguru",
]

start = [
"burr[tracking]"
]

# just install everything for developers
developer = [
"burr[streamlit]",
"burr[graphviz]",
"burr[tracking]",
"burr[tests]",
"burr[documentation]",
"loguru", # I love loguru TBH, but not for any prod stuff
"build",
"twine",
"pre-commit",
Expand Down

0 comments on commit e4da2f5

Please sign in to comment.