Skip to content

Commit be4e384

Browse files
Update README.md
1 parent f6bd8d7 commit be4e384

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -53,24 +53,24 @@ This will create a new folder `projects/myproject` with the default components a
5353

5454
## Step 2: Adding Components to Your Project
5555

56-
MiniTemplate allows you to easily add components to your project using the `add.sh` script.
56+
MiniTemplate allows you to easily add components to your project using the `run_add.sh` script.
5757

5858
### List Available Components
5959

60-
To list all available components, run the `add.sh` script without any arguments:
60+
To list all available components, run the `run_add.sh` script without any arguments:
6161

6262
```bash
63-
./scripts/add.sh
63+
./run_add.sh
6464
```
6565

6666
You will see a list of components from `components/default`, `components/custom`, and `components/converted`.
6767

6868
### Add Specific Components
6969

70-
To add a specific component to your project, pass the component name as an argument to `add.sh`:
70+
To add a specific component to your project, pass the component name as an argument to `run_add.sh`:
7171

7272
```bash
73-
./scripts/add.sh button
73+
./run_add.sh button
7474
```
7575

7676
This will copy the `button.html` component into your project directory.
@@ -101,24 +101,25 @@ This will read all HTML files in the `source` directory and convert them into se
101101

102102
## Step 4: Generating the Static Site
103103

104-
Once you have all the necessary components in place, you can generate the final `index.html` by running the `generate_site.sh` script.
104+
Once you have all the necessary components in place, you can generate the final `index.html` by running the `run_generate_site.sh` script.
105105

106106
### Generate the Static Site
107107

108108
```bash
109-
./scripts/generate_site.sh
109+
./run_generate_site.sh
110110
```
111111

112-
The script reads the main template (`template_default.html`) and replaces placeholders (like `{{header_default}}`) with the corresponding component files. The generated `index.html` file will be saved in the root of your project or the `public` directory.
112+
The script processes the main template (`template_default.html`), replacing placeholders (e.g., `{{header_default}}`) with the appropriate component files. The resulting `index.html` can be served directly on any static web host, such as GitHub Pages.
113113

114114
## Step 5: Testing the Setup
115115

116116
You can run a suite of tests to ensure that your setup is working as expected.
117117

118118
### Run the Tests
119119

120+
navigate to the root of the project, then run:
120121
```bash
121-
./tests/run_tests.sh
122+
cd ./tests && ./run_tests.sh
122123
```
123124

124125
This will execute the test suite found in the `tests/` directory and validate your project’s setup, components, and templates.

0 commit comments

Comments
 (0)