fix paths

luttje · Jul 19, 2024 · eb1f1d0 · eb1f1d0
1 parent 8fff008
commit eb1f1d0
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -6,15 +6,21 @@ This is a joke CSS-framework and it is not intended for use in production. You c
 
 ## Using the distribution
 
-1. Download [the latest release](https://github.com/luttje/css-pokemon-gameboy/releases), unzipping it to a `styles` directory in your project
+1. Download [the latest release](https://github.com/luttje/css-pokemon-gameboy/releases)
 
-2. Append the following include on the page where you want this style:
+2. The css is in the `styles` directory. All other assets are inlined into the css.
+
+3. The release contains a `template.html` to get your started.
+
+    -OR-
+
+    Append the following include on the page where you want this style:
 
     ```html
     <link rel="stylesheet" href="./styles/css-pokemon-gameboy.css">
     ```
 
-3. See the [demo](https://luttje.github.io/css-pokemon-gameboy/), [index.html](./index.html) or [.scss-files](./src/scss/) for all possible classes and effects.
+4. See the [demo](https://luttje.github.io/css-pokemon-gameboy/), [index.html](./index.html) or [.scss-files](./src/scss/) for all possible classes and effects.
 
 ## Compile it yourself
 
@@ -24,13 +30,13 @@ This is a joke CSS-framework and it is not intended for use in production. You c
 
 2. Run `npm install` to install the dependencies
 
-3. To build the demo run `npm run build` to build the distribution files to the `dist` directory
+3. To build the demo run `npm run build` to build the distribution files to the `dist` directory (preview the demo with `npm run preview`)
 
    -OR-
 
     Run `npm run dev` in the to watch for changes in the `src` directory and automatically build new distributions.
 
-4. To build the css files run `npm run build:css` to build the css file with all needed static files to the `dist-lib` directory
+4. To build the css files run `npm run build:css` to build the css file with all needed static files to the `dist-release` directory
 
 ## Third-party Licenses
 

diff --git a/index.html b/index.html
@@ -14,17 +14,17 @@
 
   <link rel="apple-touch-icon"
         sizes="180x180"
-        href="/apple-touch-icon.png">
+        href="src/apple-touch-icon.png">
   <link rel="icon"
         type="image/png"
         sizes="32x32"
-        href="/favicon-32x32.png">
+        href="src/favicon-32x32.png">
   <link rel="icon"
         type="image/png"
         sizes="16x16"
-        href="/favicon-16x16.png">
+        href="src/favicon-16x16.png">
   <link rel="manifest"
-        href="/site.webmanifest">
+        href="src/site.webmanifest">
 </head>
 
 <body>