From 5ec147e6c7c2657a0d1d4460d4c0e33f1415eac8 Mon Sep 17 00:00:00 2001
From: KtorZ <matthias.benkort@gmail.com>
Date: Fri, 6 Sep 2024 14:15:44 +0200
Subject: [PATCH] Mention config in generated README & generate env folder

  Also, get rid of the extra lib/{package_name} directory which is rarely relevant.
---
 crates/aiken/src/cmd/new.rs | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/crates/aiken/src/cmd/new.rs b/crates/aiken/src/cmd/new.rs
index 322a5842..f6596f8e 100644
--- a/crates/aiken/src/cmd/new.rs
+++ b/crates/aiken/src/cmd/new.rs
@@ -37,9 +37,10 @@ fn create_project(args: Args, package_name: &PackageName) -> miette::Result<()>
         })?;
     }
 
-    create_lib(&root, package_name)?;
+    create_lib(&root)?;
 
     if !args.lib {
+        create_env(&root)?;
         create_validators(&root)?;
     }
 
@@ -94,8 +95,13 @@ fn print_success_message(package_name: &PackageName) {
     )
 }
 
-fn create_lib(root: &Path, package_name: &PackageName) -> miette::Result<()> {
-    let lib = root.join("lib").join(&package_name.repo);
+fn create_env(root: &Path) -> miette::Result<()> {
+    let env = root.join("env");
+    fs::create_dir_all(env).into_diagnostic()
+}
+
+fn create_lib(root: &Path) -> miette::Result<()> {
+    let lib = root.join("lib");
     fs::create_dir_all(lib).into_diagnostic()
 }
 
@@ -113,8 +119,6 @@ fn readme(root: &Path, project_name: &str) -> miette::Result<()> {
 
                 Write validators in the `validators` folder, and supporting functions in the `lib` folder using `.ak` as a file extension.
 
-                For example, as `validators/always_true.ak`
-
                 ```aiken
                 validator my_first_validator {{
                   spend(_datum: Option<Data>, _redeemer: Data, _output_reference: Data, _context: Data) {{
@@ -129,13 +133,25 @@ fn readme(root: &Path, project_name: &str) -> miette::Result<()> {
                 aiken build
                 ```
 
+                ## Configuring
+
+                **aiken.toml**
+                ```toml
+                [config.default]
+                network_id = 41
+                ```
+
+                Or, alternatively, write conditional environment modules under `env`.
+
                 ## Testing
 
                 You can write tests in any module using the `test` keyword. For example:
 
                 ```aiken
+                use config
+
                 test foo() {{
-                  1 + 1 == 2
+                  config.network_id + 1 == 42
                 }}
                 ```