diff --git a/src/README.md b/src/README.md new file mode 100644 index 00000000..12dffd2a --- /dev/null +++ b/src/README.md @@ -0,0 +1,14 @@ +punk shell +============================== + + +Build Instructions +------------------------------ + ++ Use tclsh|punk make.tcl to build .tm modules and rebuild the punk86 executable + ++ Then Use tclsh|punk build.tcl to run the 'kettle' system to build docs and/or standard tcl libraries with pkgIndex.tcl files, +or - use the `pmix KettleShell` command from within the punk shell to perform kettle operations. + +(The name 'build.tcl' is the standard name used by the [Kettle](https://chiselapp.com/user/andreas_kupries/repository/Kettle/home) system) + diff --git a/src/build.tcl b/src/build.tcl index 07d32686..719accbf 100644 --- a/src/build.tcl +++ b/src/build.tcl @@ -1,4 +1,6 @@ #!/bin/sh # -*- tcl -*- \ +# 'build.tcl' name as required by kettle +# Can be run directly - but also using `pmix Kettle ...` or `pmix KettleShell ...` exec ./kettle -f "$0" "${1+$@}" kettle doc diff --git a/src/modules/punk-0.1.tm b/src/modules/punk-0.1.tm index 6c09d932..d13f5107 100644 --- a/src/modules/punk-0.1.tm +++ b/src/modules/punk-0.1.tm @@ -6709,6 +6709,7 @@ namespace eval punk { set text "" append text "Punk commands:\n" + append text " pmix (ensemble command to make new projects/modules and to generate docs)\n" append text "punk help\n" lappend chunks [list stdout $text] diff --git a/src/modules/punk/mix/templates/layouts/project/src/README.md b/src/modules/punk/mix/templates/layouts/project/src/README.md index 68102f09..a9557146 100644 --- a/src/modules/punk/mix/templates/layouts/project/src/README.md +++ b/src/modules/punk/mix/templates/layouts/project/src/README.md @@ -1,14 +1,14 @@ %project% ============================== -+ -+ +Build Instructions +------------------------------ ++ Use tclsh|punk make.tcl to build .tm modules and rebuild the executable (if applicable) -About ------------------------------- ++ Then Use tclsh|punk build.tcl to run the 'kettle' system to build docs and/or standard tcl libraries with pkgIndex.tcl files, +or - use the `pmix KettleShell` command from within the punk shell to perform kettle operations. + +(The name 'build.tcl' is the standard name used by the [Kettle](https://chiselapp.com/user/andreas_kupries/repository/Kettle/home) system) -+ -+ -+