feat: add README and tweak Makefile to update workspace cargo file (#6)

quake · web-flow · commit a54acdd06cad · 2024-03-15T14:54:41.000+13:00
diff --git a/README.md b/README.md
@@ -101,28 +101,6 @@ $ make generate
 🔧   Moving generated files into: `/tmp/my-first-contract-workspace/contracts/first-contract`...
 🔧   Initializing a fresh Git repository
 ✨   Done! New project created /tmp/my-first-contract-workspace/contracts/first-contract
-Please update workspace-level Cargo.toml so members include the newly created crate!
-```
-
-As the log line hints, after creating the contract, we will need to manually update `Cargo.toml` file to contain the newly created contract crate. When you finished editing, `Cargo.toml` file should look like following:
-
-```
-$ cat Cargo.toml
-[workspace]
-resolver = "2"
-
-members = [
-  # Please don't remove the following line, we use it to automatically
-  # detect insertion point for newly generated crates.
-  # @@INSERTION_POINT@@
-  "contracts/first-contract",
-  "tests",
-]
-
-[profile.release]
-overflow-checks = true
-strip = true
-codegen-units = 1
 ```
 
 You can also supply the contract create name when executing the make task:
diff --git a/atomics-contract/README.md b/atomics-contract/README.md
@@ -0,0 +1,7 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This contract was bootstrapped with [ckb-script-templates].*
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/atomics-contract/cargo-generate.toml b/atomics-contract/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"
diff --git a/c-wrapper-crate/README.md b/c-wrapper-crate/README.md
@@ -0,0 +1,7 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This crate was bootstrapped with [ckb-script-templates].*
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/c-wrapper-crate/cargo-generate.toml b/c-wrapper-crate/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"
diff --git a/contract/README.md b/contract/README.md
@@ -0,0 +1,7 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This contract was bootstrapped with [ckb-script-templates].*
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/contract/cargo-generate.toml b/contract/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"
diff --git a/stack-reorder-contract/README.md b/stack-reorder-contract/README.md
@@ -0,0 +1,7 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This contract was bootstrapped with [ckb-script-templates].*
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/stack-reorder-contract/cargo-generate.toml b/stack-reorder-contract/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"
diff --git a/standalone-contract/README.md b/standalone-contract/README.md
@@ -0,0 +1,7 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This contract was bootstrapped with [ckb-script-templates].*
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/standalone-contract/cargo-generate.toml b/standalone-contract/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"
diff --git a/workspace/Makefile b/workspace/Makefile
@@ -72,7 +72,7 @@ fmt:
 # Arbitrary cargo command is supported here. For example:
 #
 # make cargo CARGO_CMD=expand CARGO_ARGS="--ugly"
-# 
+#
 # Invokes:
 # cargo expand --ugly
 CARGO_CMD :=
@@ -93,7 +93,9 @@ generate:
 	if [ "x$(CRATE)" = "x" ]; then \
 		cargo generate $(TEMPLATE_TYPE) $(TEMPLATE_REPO) $(TEMPLATE) \
 			--destination $(DESTINATION); \
-		echo "Please update workspace-level Cargo.toml so members include the newly created crate!"; \
+		GENERATED_DIR=$$(ls -dt $(DESTINATION)/* | head -n 1); \
+		sed "s,@@INSERTION_POINT@@,@@INSERTION_POINT@@\n  \"$$GENERATED_DIR\"\,," Cargo.toml > Cargo.toml.new; \
+		mv Cargo.toml.new Cargo.toml; \
 	else \
 		cargo generate $(TEMPLATE_TYPE) $(TEMPLATE_REPO) $(TEMPLATE) \
 			--destination $(DESTINATION) \
diff --git a/workspace/README.md b/workspace/README.md
@@ -0,0 +1,7 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This project was bootstrapped with [ckb-script-templates].*
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/workspace/cargo-generate.toml b/workspace/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"
diff --git a/x64-simulator-crate/README.md b/x64-simulator-crate/README.md
@@ -0,0 +1,7 @@
+# {{project-name}}
+
+TODO: Write this readme
+
+*This crate was bootstrapped with [ckb-script-templates].*
+
+[ckb-script-templates]: https://github.com/cryptape/ckb-script-templates
diff --git a/x64-simulator-crate/cargo-generate.toml b/x64-simulator-crate/cargo-generate.toml
@@ -0,0 +1,2 @@
+[template]
+cargo_generate_version = ">=0.16.0"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[template]`
	`2`	`+cargo_generate_version = ">=0.16.0"`