[elpa] externals/hiddenquote 9366a25 06/14: Add Makefile and READMEs

[Stefan Monnier]

branch: externals/hiddenquote
commit 9366a2518d4113c20094578c6e77908fe0f3a76d
Author: Mauro Aranda <maurooaranda@gmail.com>
Commit: Mauro Aranda <maurooaranda@gmail.com>

    Add Makefile and READMEs
    
    * Makefile: New file.  Add simple rules to compile and make a
      distribution.
    * README: New file.  Says what is under the project directory.
    * README.md: New file, with some documentation.
---
 Makefile  | 51 ++++++++++++++++++++++++++++++++++++++++++
 README    | 19 ++++++++++++++++
 README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 146 insertions(+)

diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..7553bd7
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,51 @@
+# Copyright (C) 2021 Mauro Aranda
+
+# This file is part of hiddenquote.
+
+# hiddenquote is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# hiddenquote is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with hiddenquote.  If not, see <https://www.gnu.org/licenses/>.
+
+## Programs used.
+EMACS = emacs
+EMACSFLAGS = -batch -f batch-byte-compile
+
+## Variables (some might not be used right now).
+PACKAGE = hiddenquote
+PACKAGE_BUGREPORT = maurooaranda@gmail.com
+PACKAGE_NAME = hiddenquote
+PACKAGE_STRING = hiddenquote 0.1
+PACKAGE_TARNAME = hiddenquote-0.1
+PACKAGE_URL = 
+PACKAGE_VERSION = 0.1
+DISTDIR = $(PACKAGE_TARNAME)
+DISTFILES = COPYING README Makefile hiddenquote.el
+
+## Targets.
+
+.PHONY: all clean dist
+
+all: hiddenquote.elc
+
+hiddenquote.elc: hiddenquote.el
+       $(EMACS) $(EMACSFLAGS) hiddenquote.el
+
+clean:
+       -rm -f hiddenquote.elc
+       -rm -f $(PACKAGE_TARNAME).tar.gz
+
+dist: hiddenquote.elc
+       mkdir --parents $(DISTDIR)
+       cp --parents $(DISTFILES) $(DISTDIR)
+       tar -cf $(PACKAGE_TARNAME).tar $(DISTDIR)
+       rm -R $(DISTDIR)
+       gzip $(PACKAGE_TARNAME).tar
diff --git a/README b/README
new file mode 100644
index 0000000..7ee60c2
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+Copyright (C) 2021 Mauro Aranda
+
+This directory tree contains the hiddenquote package for GNU Emacs.
+
+^L
+This file is part of hiddenquote.
+
+hiddenquote is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+hiddenquote is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with hiddenquote.  If not, see <https://www.gnu.org/licenses/>.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..856d885
--- /dev/null
+++ b/README.md
@@ -0,0 +1,76 @@
+# hiddenquote: A different kind of word puzzle
+
+> hiddenquote is a major mode that lets you play a word puzzle you
+might not played before
+
+## Table of Contents
+
+- [Example](#example)
+- [Installation](#installation)
+- [Using](#using)
+- [License](#license)
+
+---
+
+## Example
+
+`(require 'hiddenquote)`
+`M-x hiddenquote`
+
+Select the source you want to retrieve the puzzle from (you probably
+want to select the local source, if it is your first time).
+With a prefix argument to hiddenquote, the command will prompt for a
+specific ID number.
+
+After the puzzle loads (I recommend using `toggle-frame-maximized`,
+which in vanilla Emacs is bound to `M-F10`), read the clues given in the
+Definitions buffer, and enter the words where they belong, using the
+syllables (and marking them as used) as you go.
+
+---
+
+## Installation
+You can follow these steps:
+
+- Download and open up a terminal in hiddenquote dir.
+- `make`
+- Add the directory where hiddenquote is to your load path:
+`(add-to-list 'load-path "/the/hiddenquote/dir")`
+Done!
+
+---
+
+## Using
+
+Require the file in your .init file:
+`(require 'hiddenquote)`
+`M-x hiddenquote`
+
+There are three buffers when playing a hiddenquote puzzle, so it's
+best to maximize the Emacs frame:
+- The grid buffer: Move around each cell with the usual movement
+  commands (`C-f`, `C-b`, `C-p`, `C-n`).  Complete each word by typing letters
+  into the cells.  If you make a mistake, you can delete the character
+  at point with C-d, or the character before with `backspace`.  If you
+  make a big mistake, then you can kill the whole word with
+  `C-S-backspace`, or kill the rest of the word with `C-k`.
+  To advance quickly to a far away word, use `M-g M-g`.
+  To check if you guessed right, type `?`, or click the clue number.
+  To save your progress, type `C-x C-s`.
+  To give up, and see the answers, type `C-x !`
+  To quit, without saving or giving up, type `C-x k`.
+- The clues buffer: Read the clues to guess what words should go in
+  the grid.  The clue where point is at (in the grid buffer) is always
+  highlighted.
+- The syllables buffer: Here you mark the syllables you used for each
+  word.  Toggle a syllable state (used/unused) by clicking with the
+  mouse or by hitting RET.  Once the grid is filled, and the syllables
+  are marked as used, the puzzle is complete and the timer (in the
+  grid buffer) will stop, if the solution is right.
+
+---
+
+## License
+
+- **[GPL 3](https://www.gnu.org/licenses/gpl-3.0-standalone.html)**
+- Copyright 2021 Mauro Aranda