feat: update documentation

README.md

@@ -37,8 +37,8 @@ Vivado is a pain in the ass to source control decently, so these scripts provide
 
 ### Workflow
 
- 1. When first starting a project, create it in a folder called `work_dir`
-    (e.g. `PROJECT_NAME/work_dir`). All the untracked files will be under this directory.
+ 1. When first starting a project, called `PROJECT_NAME`, create it in a folder
+    called `PROJECT_NAME/work_dir`. All the untracked files will be under this directory.
 
  2. Place your source files anywhere you want in your project folder
     (e.g. `PROJECT_NAME/src`).
@@ -74,11 +74,12 @@ Vivado is a pain in the ass to source control decently, so these scripts provide
 
  3. Initialize the git repository with `git init` on the Tcl Console. This will
     create the repository, automatically change to your project directory
-    (`PROJECT_NAME`), generate the `.gitignore` file and stage it.
+    (`PROJECT_NAME`), generate the `.gitignore` file and a `README.md` file
+    with basic *how to use* instructions and make the initial commit.
 
  4. Stage your source files with `git add`.
 
- 5. When you are done, `git commit` your project. A `PROJECT_NAME.tcl`
+ 5. When you are done, `git commit` your project **within the Tcl Console**. A `PROJECT_NAME.tcl`
     script will be created in your `PROJECT_NAME` folder and added to your commit.
 
  6. Afterwards, when opening the project after cloning it, do it by using

scripts/git_wrapper.tcl

@@ -71,13 +71,13 @@ namespace eval ::git_wrapper {
         puts $file ""
         puts $file "- Wenn you are done, `git add` your source/design files."
         puts $file ""
-        puts $file "- Use the Tcl Console from Vivado to `git commit -m \"COMMIT_MESSAGE\"` your work. The `${current_project}.tcl` file will be recreated"
+        puts $file "- Use the **Tcl Console** from Vivado to `git commit -m \"COMMIT_MESSAGE\"` your work. The `${current_project}.tcl` file will be recreated"
         puts $file ""
         puts $file "### Notes"
         puts $file ""
         puts $file "#### Block design"
         puts $file ""
-        puts $file "When you change a block design, **befor you run synthesis** you have to disable the current HDL wrapper and create a new HDL wrapper for each design!"
+        puts $file "When you change a block design, **befor you run synthesis** you have to *delete* the current HDL wrapper and *create a new* HDL wrapper for each changed design!"
         close $file
 
         # Initialize the repo