docs: update develop.md (#225)

* docs: update develop.md

* docs: update other readme

Author: RetricSu

README.md

@@ -52,6 +52,12 @@ Start building on CKB blockchain, right now, right away!
 npm install -g @offckb/cli
 ```
 
+or use `pnpm` to install:
+
+```sh
+pnpm install -g @offckb/cli
+```
+
 _We recommend using [LTS](https://nodejs.org/en/download/package-manager) version of Node to run `offckb`_
 
 ## Usage

docs/develop.md

@@ -26,10 +26,16 @@ edit the things in `templates/v${version}`
 
 ### Install dependencies
 
-Since we use `pnpm` as a developing package manager, people install `offckb` by `npm` would require a `package-lock.json` file.
+Since we use `pnpm` as a developing package manager, people install `offckb` by `npm` would require a [`npm-shrinkwrap.json`](https://docs.npmjs.com/cli/v8/commands/npm-shrinkwrap) file.
+
+When updating the dependencies, remember to run the following command to generate the `npm-shrinkwrap.json` file.
 
 ```sh
-npm i --package-lock-only
+pnpm add <new-dependency>
+
+// run the following to keep npm-shrinkwrap consistent with out pnpm-lock.json
+
+npm shrinkwrap
 ```
 
 Remember to run the above command when trying to publish a new version.

templates/v3/next-js-template/README.md

@@ -1,7 +1,104 @@
-# next-js-template-1
+# offckb-template
 
-TODO: Write this readme
+This is a Minimal Template for CKB Full-Stack Dapps generated by [offckb](https://github.com/RetricSu/offckb).
 
-_This project was bootstrapped with [ckb-script-templates]._
+Offckb does not do the magic. It just wraps the new CKB smart contract template and the CKB javascript Dapp framework into one mono-repo. Under the hook, it uses:
 
-[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
+- [ckb-scripts-template](https://github.com/cryptape/ckb-script-templates) for smart contract development
+- [next-js](https://nextjs.org/docs?utm_source=create-next-app&utm_medium=appdir-template&utm_campaign=create-next-app) and [ccc](https://github.com/ckb-devrel/ccc) for frontend development
+
+## Smart contract development
+
+By default, this template comes with a single simple smart contract `hello-world`: `contracts/hello-world/src/main.rs`.
+
+The smart contract is written in Rust lang. In order to develop, the following dependencies are required:
+
+- `git`, `make`, `sed`, `bash`, `sha256sum` and others Unix utilities.
+- `Rust` with `riscv64 target`: `rustup target add riscv64imac-unknown-none-elf`
+- `Clang 18+`
+- `cargo-generate`
+
+Check out the ckb-script-templates for more [detail](https://github.com/cryptape/ckb-script-templates/blob/main/README.md#dependencies)
+
+### Usage
+
+add a new smart-contract:
+
+```sh
+make generate
+```
+
+build smart-contract:
+
+```sh
+make build
+```
+
+run test:
+
+```sh
+make test
+```
+
+For more detail, check out [ckb-script-templates](https://github.com/cryptape/ckb-script-templates)
+
+## dApp frontend development
+
+first, enter the frontend workspace:
+
+```sh
+cd frontend
+```
+
+start the app:
+
+```sh
+npm i && npm run dev
+```
+
+change the CKB blockchain network:
+
+edit `.env` file:
+
+```bash
+NEXT_PUBLIC_NETWORK=devnet # devnet, testnet or mainnet
+```
+
+## Deploy to devnet/testnet with offckb
+
+Once you build your smart contracts, you can deploy them to CKB blockchain with [ckb-cli](https://github.com/nervosnetwork/ckb-cli) or any other tools.
+
+If you want to test them in devnet/testnet blockchain, then `offckb` might be the ideal selection.
+
+`offckb` will look for the `offckb.config.ts` file to read config information. so you will need to enter the frontend workspace to do the instruction:
+
+```sh
+cd frontend
+offckb deploy --network devnet
+```
+
+If successfully deployed, you will see the deploy script info for your smart contract recorded in the path recorded in the `offckb.config.ts` file.
+
+Every time you deploy a new version of your smart contracts, those script infos will be updated by `offckb` in the place recorded in `offckb.config.ts` and work out-of-box in your frontend.
+
+You can also deploy smart contracts to the CKB Testnet like this:
+
+```sh
+cd frontend
+offckb deploy --network testnet
+```
+
+and start your frontend Dapp targeting Testnet:
+
+edit `.env` file:
+
+```bash
+NEXT_PUBLIC_NETWORK=testnet # devnet, testnet or mainnet
+```
+
+```bash
+cd frontend
+npm run dev
+```
+
+Note that the `mainnet` network is not supported in `offckb` since `offckb` is focusing on building a friendly development environment for CKB. To gain better security, it is recommended to use production tools like [ckb-cli](https://github.com/nervosnetwork/ckb-cli) to deploy smart contracts and do transactions for the CKB mainnet.

templates/v3/remix-vite-template/README.md

@@ -1,7 +1,109 @@
-# temp-template
+# offckb-template
 
-TODO: Write this readme
+This is a Minimal Template for CKB Full-Stack Dapps generated by [offckb](https://github.com/RetricSu/offckb).
 
-_This project was bootstrapped with [ckb-script-templates]._
+Offckb does not do the magic. It just wraps the new CKB smart contract template and the CKB javascript Dapp framework into one mono-repo. Under the hook, it uses:
 
-[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
+- [ckb-scripts-template](https://github.com/cryptape/ckb-script-templates) for smart contract development
+- [remix-vite](https://remix.run/tutorials/blog) and [CCC](https://github.com/ckb-devrel/ccc) for frontend development
+
+## Smart contract development
+
+By default, this template comes with a single simple smart contract `hello-world`: `contracts/hello-world/src/main.rs`.
+
+The smart contract is written in Rust lang. In order to develop, the following dependencies are required:
+
+- `git`, `make`, `sed`, `bash`, `sha256sum` and others Unix utilities.
+- `Rust` with `riscv64 target`: `rustup target add riscv64imac-unknown-none-elf`
+- `Clang 18+`
+- `cargo-generate`
+
+Check out the ckb-script-templates for more [detail](https://github.com/cryptape/ckb-script-templates/blob/main/README.md#dependencies)
+
+### Usage
+
+add a new smart-contract:
+
+```sh
+make generate
+```
+
+build smart-contract:
+
+```sh
+make build
+```
+
+run test:
+
+```sh
+make test
+```
+
+run test with contract-debug logs:
+
+```sh
+cargo test -- --nocapture
+```
+
+For more detail, check out [ckb-script-templates](https://github.com/cryptape/ckb-script-templates)
+
+## Dapp frontend development
+
+first, enter the frontend workspace:
+
+```sh
+cd frontend
+```
+
+start the app:
+
+```sh
+npm i && npm run dev
+```
+
+change the CKB blockchain network:
+
+```sh
+export NETWORK=devnet # or testnet, mainnet
+npm run dev
+```
+
+or
+
+```sh
+NETWORK=devnet npm run dev
+```
+
+## Deploy to devnet/testnet with offckb
+
+Once you build your smart contracts, you can deploy them to CKB blockchain with [ckb-cli](https://github.com/nervosnetwork/ckb-cli) or any other tools.
+
+If you want to test them in devnet/testnet blockchain, then `offckb` might be the ideal selection.
+
+`offckb` will look for the `offckb.config.ts` file to read config information. so you will need to enter the frontend workspace to do the instruction:
+
+```sh
+cd frontend
+offckb deploy --network devnet
+```
+
+If successfully deployed, you will see the deploy script info for your smart contract recorded in the path recorded in the `offckb.config.ts` file.
+
+Every time you deploy a new version of your smart contracts, those script infos will be updated by `offckb` in the place recorded in `offckb.config.ts` and work out-of-box in your frontend.
+
+You can also deploy smart contracts to the CKB Testnet like this:
+
+```sh
+cd frontend
+offckb deploy --network testnet
+```
+
+and start your frontend Dapp targeting Testnet:
+
+```sh
+cd frontend
+NETWORK=testnet npm run dev
+```
+
+Note that the `mainnet` network is not supported in `offckb` since `offckb` is focusing on building a friendly development environment for CKB. To gain better security, it is recommended to use production tools like [ckb-cli](https://github.com/nervosnetwork/ckb-cli) to deploy smart contracts and do transactions for the CKB mainnet.