Skip to content

Commit 9dc58dd

Browse files
committed
small readme edits [skip ci]
1 parent 951df2e commit 9dc58dd

File tree

2 files changed

+12
-31
lines changed

2 files changed

+12
-31
lines changed

Makefile

Lines changed: 0 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,32 +19,6 @@ trace:
1919
RUST_LOG=warn,dkn_compute=trace,libp2p=debug \
2020
cargo run --bin dkn-compute
2121

22-
.PHONY: ollama-versions
23-
ollama-versions:
24-
@cat Cargo.lock | grep "https://github.com/andthattoo/ollama-workflows"
25-
@cat Cargo.lock | grep "https://github.com/andthattoo/ollama-rs"
26-
27-
.PHONY: test # | Run tests
28-
test:
29-
cargo test --workspace
30-
31-
###############################################################################
32-
.PHONY: lint # | Run linter (clippy)
33-
lint:
34-
cargo clippy --workspace
35-
36-
.PHONY: format # | Run formatter (cargo fmt)
37-
format:
38-
cargo fmt -v
39-
40-
.PHONY: version # | Print version
41-
version:
42-
@cargo pkgid | cut -d@ -f2
43-
44-
.PHONY: docs # | Generate & open documentation
45-
docs:
46-
cargo doc --open --no-deps --document-private-items
47-
4822
# https://stackoverflow.com/a/45843594
4923
.PHONY: help # | List targets
5024
help:

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -87,31 +87,38 @@ docker compose --profile=ollama-cuda up
8787
docker compose --profile=ollama-rocm up
8888
```
8989

90+
Note that we are very dependent on Ollama packages, and it is important to check their versions if relevant:
91+
92+
```sh
93+
@cat Cargo.lock | grep "https://github.com/andthattoo/ollama-workflows"
94+
@cat Cargo.lock | grep "https://github.com/andthattoo/ollama-rs"
95+
```
96+
9097
### Testing
9198

9299
You can the tests as follows:
93100

94101
```sh
95-
make test
102+
cargo test --workspace
96103
```
97104

98105
We also have some benchmarking and profiling scripts, see [node performance](./docs/NODE_PERFORMANCE.md) for more details.
99106

100107
### Documentation
101108

102-
You can view the inline documentation with:
109+
You can view the entire crate-level documentation with:
103110

104111
```sh
105-
make docs
112+
cargo doc --open --no-deps --document-private-items
106113
```
107114

108115
### Styling
109116

110117
Lint and format with:
111118

112119
```sh
113-
make lint # clippy
114-
make format # rustfmt
120+
cargo clippy --workspace
121+
cargo fmt -v
115122
```
116123

117124
### Profiling

0 commit comments

Comments
 (0)