Skip to content

Commit

Permalink
add rye install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
carderne committed Aug 22, 2024
1 parent d947ea1 commit 03f65a0
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,12 @@ You can see examples for each of the two styles here:
This will give you a quick view of how this all works.
A `packages` style will be used by default, as it is probably more familiar to most.

First install Rye:
```bash
curl -sSf https://rye.astral.sh/get | bash
```

And start your workspace:
```bash
rye init unarepo # choose another name if you prefer
cd unarepo
Expand Down
8 changes: 8 additions & 0 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@
This will give you a quick view of how this all works.
A `packages` style will be used by default, as it is probably more familiar to most.

First install Rye:
```bash
curl -sSf https://rye.astral.sh/get | bash
```

And start your workspace:
```bash
rye init unarepo # choose another name if you prefer
cd unarepo
Expand Down Expand Up @@ -69,4 +75,6 @@ docker run --rm -it unarepo-printer python -c 'from unarepo.printer import run;

## Example
After running through the steps above, the result will be similar to the Projects style example repo:

- [una-example-packages](https://github.com/carderne/una-example-packages)
- [una-example-modules](https://github.com/carderne/una-example-modules)
3 changes: 0 additions & 3 deletions una/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ class OrgImports:
class Include:
src: str
dst: str
# path: str
# include: str
# root: str


@dataclass(frozen=True)
Expand Down

0 comments on commit 03f65a0

Please sign in to comment.