Browse Source

Add uninstallation instructions. Fix #38.

Herbert Vojčík 9 years ago
parent
commit
a53366f4f3
3 changed files with 68 additions and 3 deletions
  1. 5 3
      root/index.html
  2. 24 0
      root/parts.html
  3. 39 0
      root/uninstall.html

+ 5 - 3
root/index.html

@@ -9,9 +9,11 @@
   </head>
 
   <body>
-  <p>Hi, {%= author_name %}! Welcome to Amber project: "{%= title %}".</p>
-  <p>This is the place for your application's HTML. After getting familiar with Amber,
-      just remove this welcome contents from index.html and replace it with your own.</p>
+  <p>This is a sample app. It contains some
+  <a href="parts.html">batteries included</a>
+  and should be
+  <a href="uninstall.html">cleaned up</a>
+  once you start developing your own  app / lib.</p>
   <button id="amber-with">Hello from TagBrush >> with:</button>
   <button id="jquery-append">Hello from jQuery append</button>
   <ol id="output-list"></ol>

+ 24 - 0
root/parts.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+    <title>{%= title %}</title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <meta name="author" content="{%= author_name %}" />
+  </head>
+
+  <body>
+  <p>The sample app contains three additional parts beyond Amber itself:</p>
+  <ul style="width: 40ex">
+      <li>The elements in <code>index.html</code>
+          <code>&lt;body&gt;</code> tag.</li>
+      <li><code>amber-contrib-jquery</code> module,
+          providing jQuery and a wrapper over it.</li>
+      <li><code>amber-contrib-web</code> module,
+          providing <code>Web</code> package
+          that allows for DOM manipulation
+          and is inspired by Seaside.</li>
+  </ul>
+  </body>
+
+</html>

+ 39 - 0
root/uninstall.html

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+
+  <head>
+    <title>{%= title %}</title>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <meta name="author" content="{%= author_name %}" />
+  </head>
+
+  <body>
+  <p>Once you start developing your own app / lib, you should
+      remove all unnecessary parts left from the sample app.</p>
+  <ul style="width: 40ex">
+      <li>In <code>index.html</code>
+          <code>&lt;body&gt;</code> tag,
+          everything should be removed, except
+          the <code>&lt;script&gt;</code> tag
+          that initializes Amber and starts your app;
+          then you can add elements specific to your own app
+          to the page.</li>
+      <li>If you aren't going to use <code>Web</code>
+          package from <code>amber-contrib-web</code> module,
+          but want to retain the jQuery wrapper,
+          you should run <code>bower uninstall amber-contrib-web --save</code>
+          from your CLI.</li>
+      <li>If you aren't going to use the <code>Web</code>
+          package from the <code>amber-contrib-web</code> module,
+          nor the jQuery wrapper from <code>amber-contrib-jquery</code>,
+          you should run <code>bower uninstall amber-contrib-web amber-contrib-jquery --save</code>
+          from your CLI.</li>
+      <li>You cannot remove just the jQuery wrapper and retain the Web package,
+          as it depends on the jQuery wrapper.</li>
+      <li>As the last step, make sure the dependency tree is in a correct state
+          by recreating it: first delete your <code>bower_components</code> folder,
+          then run <code>bower install</code> from your CLI.</li>
+  </ul>
+  </body>
+
+</html>