Skip to content

Commit

Permalink
Merge pull request #566 from CosmWasm/tkulik/move_spec_docs
Browse files Browse the repository at this point in the history
docs: Move relevant info from `spec` to cosmwasm documentation
  • Loading branch information
chipshort authored Oct 23, 2024
2 parents 198f254 + 0661bee commit f86be64
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 452 deletions.
5 changes: 5 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ build-libwasmvm:
cp libwasmvm/target/release/$(SHARED_LIB_SRC) internal/api/$(SHARED_LIB_DST)
make update-bindings

# build and show the Rust documentation of the wasmvm
.PHONY: doc-rust
doc-rust:
(cd libwasmvm && cargo doc --no-deps --open)

.PHONY: build-go
build-go:
go build ./...
Expand Down
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ allows you to compile, initialize and execute CosmWasm smart contracts from Go
applications, in particular from
[x/wasm](https://github.com/CosmWasm/wasmd/tree/master/x/wasm).

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

## Structure

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

### Go code

The Go code consistes of three packages:
The Go code consists of three packages:

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

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

## Docs

Run `(cd libwasmvm && cargo doc --no-deps --open)`.

## Design

Please read the [Documentation](./spec/Index.md) to understand both the general
[Architecture](./spec/Architecture.md), as well as the more detailed
[Specification](./spec/Specification.md) of the parameters and entry points.

## Development

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

Expand Down
120 changes: 0 additions & 120 deletions spec/Architecture.md

This file was deleted.

68 changes: 0 additions & 68 deletions spec/Index.md

This file was deleted.

Loading

0 comments on commit f86be64

Please sign in to comment.