Skip to content

Commit bc736a8

Browse files
authored
Update README.md (#19)
* Update README.md Add a note deprecating atomics-contract * Update README.md Update wording * Update README.md Update typo
1 parent a9d8dd7 commit bc736a8

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,11 +145,14 @@ $ make generate TEMPLATE=c-wrapper-crate DESTINATION=crates # generate a crat
145145
Ready-to-use templates have been put together for different use cases:
146146

147147
* `contract`: default contract template you should use if no special requirements are neeeded.
148-
* `atomics-contract`: a contract template that supports atomic builtins without requiring RISC-V A extension. This template allows you to use `log`, `bytes` crate or other code that might deal with atomics.
149148
* `stack-reorder-contract`: a contract template that adjusts memory layout so stack lives at lower address, and heap lives at higher address. This way a program would explicitly signal errors when stack space is fully use.
150149
* `c-wrapper-crate`: a crate template that shows how to glue C code in a Rust crate for CKB's contract usage.
151150
* `x64-simulator-crate`: a crate template that contains Rust-only code, but usees [ckb-x64-simulator](https://github.com/nervosnetwork/ckb-x64-simulator) for tests.
152151

152+
There are also deprecated templates kept for historical reasons.
153+
154+
* `atomics-contract`: a contract template that supports atomic builtins without requiring RISC-V A extension. This template allows you to use `log`, `bytes` crate or other code that might deal with atomics. Note that starting from ckb-std v0.16.0, atomic builtins are provided in ckb-std by default. For Rust based scripts, relying the builtin implementation in ckb-std might be better and more smooth idea. We are still keeping this template for now as a hint for a C based solution. It might be removed in future versions.
155+
153156
Certain template might require external modules to be available, for example:
154157

155158
* All C code would require [ckb-c-stdlib](https://github.com/nervosnetwork/ckb-c-stdlib): `git submodule add https://github.com/nervosnetwork/ckb-c-stdlib deps/ckb-c-stdlib`

0 commit comments

Comments
 (0)