Browse Source

Update docs with basic build/make instructions

master
Julian Noble 1 year ago
parent
commit
2263d4a1bc
  1. 14
      src/README.md
  2. 2
      src/build.tcl
  3. 1
      src/modules/punk-0.1.tm
  4. 14
      src/modules/punk/mix/templates/layouts/project/src/README.md

14
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)

2
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

1
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]

14
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)
+
+
+

Loading…
Cancel
Save