Skip to content

Commit

Permalink
Update README (#26)
Browse files Browse the repository at this point in the history
  • Loading branch information
aminalaee authored Oct 3, 2023
1 parent b278623 commit 5077c3a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 2 deletions.
24 changes: 24 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
.DEFAULT_GOAL := all

.PHONY: build
build:
RUSTFLAGS="--cfg uuid_unstable" maturin develop

.PHONY: format
format:
black python/
ruff --fix python/
cargo fmt

.PHONY: lint
lint:
ruff python/
black --check --diff python/
mypy python/

.PHONY: test
test:
pytest tests -vvv

.PHONY: all
all: format build lint test
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,15 @@ UUID('6fa459ea-ee8a-3ca4-894e-db77e160355e')
- The `getnode` function is not available.
- The `uuid1` and `uuid6` take `node` argument as mandatory.

## How to build
## How to develo

```shell
$ make build
$ make test
```

Or:

```bash
RUSTFLAGS="--cfg uuid_unstable" maturin develop
$ RUSTFLAGS="--cfg uuid_unstable" maturin develop
```

0 comments on commit 5077c3a

Please sign in to comment.