Refine the build instructions

chpock · May 5, 2024 · ac2ab4f · ac2ab4f
1 parent 1624bbc
commit ac2ab4f
Show file tree

Hide file tree

Showing 7 changed files with 27 additions and 8 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,6 +1,7 @@
 2024-05-05 Konstantin Kushnir <chpock@gmail.com>
 	* Bumped version to 1.1.0
 	* Fix typo
+	* Refine the build instructions
 
 2024-04-28 Konstantin Kushnir <chpock@gmail.com>
-	* RELEASE TAG 1.0.0
+	* RELEASE TAG 1.0.0
diff --git a/README.md b/README.md
@@ -48,8 +48,11 @@ building with Mingw-w64 toolchain is supported.
 The standard TEA config, make and install process is supported.
 
 ```
+$ git clone https://github.com/chpock/tclmtls.git
 $ cd tclmtls
-$ ./configure
+$ git submodule update --init --recursive
+$ mkdir build && cd build
+$ ../configure
 $ make
 $ make test
 $ make install

diff --git a/before-release.sh b/before-release.sh
@@ -3,7 +3,16 @@
 SELF_DIR="$(dirname "$0")"
 VERSION="$(cat "$SELF_DIR/version")"
 
-rm -f "$SELF_DIR/manifest.uuid"
+(
+    cd "$SELF_DIR"
+    printf "git-" >"$SELF_DIR"/manifest.uuid
+    git rev-parse HEAD >>"$SELF_DIR"/manifest.uuid || (
+        printf "svn-r" >"$SELF_DIR"/manifest.uuid
+        svn info --show-item last-changed-revision >>"$SELF_DIR"/manifest.uuid
+    ) || (
+        printf "unknown" >"$SELF_DIR"/manifest.uuid
+    )
+)
 
 tclsh "$SELF_DIR/tools/ruff.tcl" "::Introduction ::mtls" -preeval "source $SELF_DIR/doc/doc.ruff" \
     -outdir "$SELF_DIR/doc" -outfile "mtls.html" -product "mtls" -version "$VERSION" \

diff --git a/doc/doc.ruff b/doc/doc.ruff
@@ -60,8 +60,11 @@ namespace eval Introduction {
         The standard TEA config, make and install process is supported.
 
         ```
+        $ git clone https://github.com/chpock/tclmtls.git
         $ cd tclmtls
-        $ ./configure
+        $ git submodule update --init --recursive
+        $ mkdir build && cd build
+        $ ../configure
         $ make
         $ make test
         $ make install

diff --git a/doc/mtls.html b/doc/mtls.html
@@ -6,7 +6,7 @@
 <body style='--ruff-nav-toc-offset: 1em;'>
 <div class='ruff-layout'>
 <header class='ruff-layout-header ruff-hd'>
-<a style='text-decoration:none;' href='mtls.html'>Mtls (v1.0.0)</a>
+<a style='text-decoration:none;' href='mtls.html'>Mtls (v1.1.0)</a>
 
 
             <div id="ruffButtonBar">
@@ -50,8 +50,11 @@ <h2 class='ruff'><a name='::Introduction-How to build'></a>How to build<span cla
 <p class='ruff'>The standard TEA config, make and install process is supported.</p>
 
 <figure  class='ruff-snippet ruff-figure'><pre class='ruff'>
+$ git clone https://github.com/chpock/tclmtls.git
 $ cd tclmtls
-$ ./configure
+$ git submodule update --init --recursive
+$ mkdir build &amp;&amp; cd build
+$ ../configure
 $ make
 $ make test
 $ make install

diff --git a/doc/mtls.n b/doc/mtls.n
@@ -1,6 +1,6 @@
 '\"
 '\"
-.TH "mtls" 3tcl 1\&.0\&.0 "mtls" "Mtls"
+.TH "mtls" 3tcl 1\&.1\&.0 "mtls" "Mtls"
 .SH NAME
 Introduction - Mtls
 .SH SYNOPSIS

diff --git a/manifest.uuid b/manifest.uuid
@@ -1 +1 @@
-git-7770b7fe7e40c93fbe166c091c54fe3129cd6a35
+git-1624bbce7392d94a5e7099bc3365af4a94acd82a
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		git-7770b7fe7e40c93fbe166c091c54fe3129cd6a35
		git-1624bbce7392d94a5e7099bc3365af4a94acd82a