summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorZhineng Li <[email protected]>2026-04-30 21:16:49 +0800
committerZhineng Li <[email protected]>2026-04-30 21:16:49 +0800
commitc87a31db642ac37c3989967bd9a469be5ef28531 (patch)
tree80a46b04abd1f475c049728eed1b03c436fdf6e9
parent29139678fcaaaefd50d2210b6517791fd0167b22 (diff)
downloadword-search-game-c87a31db642ac37c3989967bd9a469be5ef28531.tar.gz
word-search-game-c87a31db642ac37c3989967bd9a469be5ef28531.zip
update readme
-rw-r--r--README26
-rw-r--r--README.html15
-rw-r--r--README.md19
3 files changed, 26 insertions, 34 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..59a86c9
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@
+Word Search Game
+================
+
+A word search game built with the JavaScript Canvas API. It supports mouse,
+touch, and keyboard selection, and is straightforward to customize.
+
+
+Development
+===========
+
+The script uses ES modules, so `index.html` must be served via an HTTP
+server rather than opened directly from the filesystem.
+
+ npx serve .
+
+
+Author
+======
+
+Zhineng Li <[email protected]>
+
+
+License
+=======
+
+The code is released under the MIT license.
diff --git a/README.html b/README.html
deleted file mode 100644
index 40f3a9f..0000000
--- a/README.html
+++ /dev/null
@@ -1,15 +0,0 @@
-<h1 id="word-search-game">Word search game</h1>
-<p>A word game which programming with HTML5 and Javascript.</p>
-<h2 id="requirment">Requirment</h2>
-<ul>
-<li>Internet Explorer 10</li>
-<li>Google Chrome 8</li>
-<li>Opera 11.5</li>
-<li>Safari 5</li>
-</ul>
-<h2 id="license">License</h2>
-<p>The MIT License (MIT)</p>
-<p>Copyright (c) 2013 Li Zhineng &lt;[email protected]&gt; and other <code>word-search-game</code> contributors</p>
-<p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the &quot;Software&quot;), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
-<p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
-<p>THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
diff --git a/README.md b/README.md
deleted file mode 100644
index fa16d94..0000000
--- a/README.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# Word search game
-A word game which programming with HTML5 and Javascript.
-
-## Requirements
-* Internet Explorer 10
-* Google Chrome 8
-* Opera 11.5
-* Safari 5
-
-## License
-The MIT License (MIT)
-
-Copyright (c) 2013 Li Zhineng &lt;[email protected]&gt; and other `word-search-game` contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.