Skip to content

Commit f86be64

Browse files
authored
Merge pull request #566 from CosmWasm/tkulik/move_spec_docs
docs: Move relevant info from `spec` to cosmwasm documentation
2 parents 198f254 + 0661bee commit f86be64

File tree

5 files changed

+11
-452
lines changed

5 files changed

+11
-452
lines changed

Makefile

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ build-libwasmvm:
4848
cp libwasmvm/target/release/$(SHARED_LIB_SRC) internal/api/$(SHARED_LIB_DST)
4949
make update-bindings
5050

51+
# build and show the Rust documentation of the wasmvm
52+
.PHONY: doc-rust
53+
doc-rust:
54+
(cd libwasmvm && cargo doc --no-deps --open)
55+
5156
.PHONY: build-go
5257
build-go:
5358
go build ./...

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ allows you to compile, initialize and execute CosmWasm smart contracts from Go
66
applications, in particular from
77
[x/wasm](https://github.com/CosmWasm/wasmd/tree/master/x/wasm).
88

9+
More information on what is CosmWasm and how to use it can be found here:
10+
[CosmWasm Docs](https://docs.cosmwasm.com). To generate and show
11+
the Rust part documentation you can run `make doc-rust`.
12+
913
## Structure
1014

1115
This repo contains both Rust and Go code. The Rust code is compiled into a
@@ -37,7 +41,7 @@ make release-build-windows
3741

3842
### Go code
3943

40-
The Go code consistes of three packages:
44+
The Go code consists of three packages:
4145

4246
1. The types (the `github.com/CosmWasm/wasmvm/types` import), using
4347
`package types`
@@ -146,19 +150,9 @@ which for example excludes all 32 bit systems.
146150

147151
<!-- AUTO GENERATED BY libwasmvm_builds.py END -->
148152

149-
## Docs
150-
151-
Run `(cd libwasmvm && cargo doc --no-deps --open)`.
152-
153-
## Design
154-
155-
Please read the [Documentation](./spec/Index.md) to understand both the general
156-
[Architecture](./spec/Architecture.md), as well as the more detailed
157-
[Specification](./spec/Specification.md) of the parameters and entry points.
158-
159153
## Development
160154

161-
There are two halfs to this code - go and rust. The first step is to ensure that
155+
There are two halves to this code - go and rust. The first step is to ensure that
162156
there is a proper dll built for your platform. This should be `api/libwasmvm.X`,
163157
where X is:
164158

spec/Architecture.md

Lines changed: 0 additions & 120 deletions
This file was deleted.

spec/Index.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

0 commit comments

Comments
 (0)