Merge pull request #116 from macneko-ayu/update-readme-of-create-vivl…

…iostyle-theme-template update-readme-of-create-vivliostyle-theme-template
vivliostyle · Sep 28, 2023 · 6229f19 · 6229f19
2 parents cc99824 + 3e09265
commit 6229f19
Showing 1 changed file with 19 additions and 10 deletions.
diff --git a/packages/create-vivliostyle-theme/templates/default/README.md b/packages/create-vivliostyle-theme/templates/default/README.md
@@ -16,6 +16,17 @@ module.exports = {
 };
 ```
 
+If you want to add your CSS:
+
+```js
+module.exports = {
+  theme: [
+    '{{kebab name}}',
+    // add your CSS 
+  ],
+};
+```
+
 ## Dev
 
 ### Files
@@ -25,28 +36,26 @@ module.exports = {
 ├── LICENSE
 ├── README.md
 ├── example
-│   ├── default.html       // auto generated
-│   └── default.md         // 🖋
+│   ├── assets                            // auto generated
+│   │   └── Logo (Mark + Type).png        // auto generated
+│   └── default.md                        // 🖋
 ├── package.json
-├── theme.css              // 🖋
+├── theme.css                             // 🖋
 └── vivliostyle.config.js
 ```
 
 **example**: Contain sample manuscripts using your theme.
 
-**scss**: You can add files for specific use (print, screen, cover, toc, preface, ...) and apply them at `theme` `entry > theme` in vivliostyle.config.js. Partial files whose names begin with `_` will be ignored.
-
-
 ### Commands
 
-Run `vivliostyle preview` to preview your `theme_*.css`.
+Run `vivliostyle preview` to preview your `theme.css`.
 
-To watch file changes, use `dev` script.
+To watch file changes, use `preview` script.
 
 ```bash
-npm run dev
+npm run preview
 # or
-yarn dev
+yarn preview
 ```
 
 You can specify your CSS file and manuscript file for preview in vivliostyle.config.js: