summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHumble Penguin <92458623+humblepenguinn@users.noreply.github.com>2023-04-05 16:58:10 +0500
committerGitHub <noreply@github.com>2023-04-05 16:58:10 +0500
commit1ecd336a886a84b116755b65a448e2d9449db41e (patch)
treeb4cf003543f4509afbd1cdfda71991b386f255e2
parent527d010d2e1f0194e52d7c865e2eab9b3faf3c98 (diff)
Update README.md
-rw-r--r--README.md43
1 files changed, 21 insertions, 22 deletions
diff --git a/README.md b/README.md
index 58b846c..faf7d0f 100644
--- a/README.md
+++ b/README.md
@@ -13,11 +13,29 @@ A User Friendly CLI Tool For Creating New Projects With Templates
`tmplt` is a command-line tool that lets users quickly create new projects based on templates. With `tmplt`, users can create a new project that is set up with all the necessary files and dependencies, so they can get started on their project right away.
-With `tmplt`, users can create templates that define the structure and dependencies of a new project. These templates can be customized to fit specific project needs and shared with others. `tmplt` comes with a simple yet flexible syntax for defining templates that can include variables, files, and dependencies.
+With `tmplt`, users can create templates that define the structure and dependencies of a new project. These templates can be customized to fit specific project needs and shared with others. `tmplt` comes with a simple yet flexible syntax for defining `templates` that can include variables, files, and dependencies.
-Templates are defined in a `yaml` file that lists all the files to be generated, the dependencies to be installed, and the variables to be replaced.
+`Templates` are defined in a `yaml` file that lists all the files to be generated, the dependencies to be installed, and the variables to be replaced.
-Here's an example template for a Pygame project:
+## Templates
+`Templates` are files that contain information about the project, its dependencies, files to generate, and variables. Users can use these templates to set up projects easily.
+
+A `template` file is written in `YAML` format and contains the following information:
+
+* Name: The name of the template.
+
+* Description: A short description of the template.
+
+* Dependencies: A list of dependencies required by the project. Each dependency contains a name and an install command.
+
+* Files: A list of files to generate for the project. Each file contains a name and the content to be
+written to the file.
+
+* Variables: A list of variables that can be used in the template. Each variable contains a name, description, and default value.
+
+Users can create their own `templates` or download them from the internet. To create a new project from a `template`, simply run the `tmplt new` command and provide the name of the template. The tool will generate all the necessary files and install the required dependencies. See [usage.md](./docs/usage.md) for more information on how to use the tool
+
+Here's an example `template` for a Pygame project:
```yaml
# Pygame Project Template
@@ -79,25 +97,6 @@ variables:
default: 600
```
-## Templates
-Templates are files that contain information about the project, its dependencies, files to generate, and variables. Users can use these templates to set up projects easily.
-
-A template file is written in `YAML` format and contains the following information:
-
-* Name: The name of the template.
-
-* Description: A short description of the template.
-
-* Dependencies: A list of dependencies required by the project. Each dependency contains a name and an install command.
-
-* Files: A list of files to generate for the project. Each file contains a name and the content to be
-written to the file.
-
-* Variables: A list of variables that can be used in the template. Each variable contains a name, description, and default value.
-
-Users can create their own templates or download them from the internet. To create a new project from a template, simply run the `tmplt new` command and provide the name of the template. The tool will generate all the necessary files and install the required dependencies.
-
-
## Installation
You can install `tmplt` through a few methods