README.txt

   1                         Anagram
   2                         =======
   3
   4 What is Anagram?
   5 -------------------
   6
   7 Anagram is a C++ application for finding anagrams of a given
   8 word. Anagram has two modes- a cli mode for command line usage and a
   9 gui mode for graphical interface. Both modes use separate binary
  10 files. Anagram supports both single-word and multi-word anagrams,
  11 although multi-word anagram searches may take a very long time. Apart
  12 from anagram searching Anagram provides a few other functionalities
  13 such as palindrome identification, dictionary checking etc.
  14
  15 Anagram is written in C++ and needs to be compiled before use.
  16
  17 Downloading
  18 -----------
  19
  20 Latest release of Anagram can be downloaded from
  21 http://code.agnibho.com/anagram/
  22
  23 The source code is available at https://github.com/agnibho/anagram/
  24
  25 Installation
  26 ------------
  27
  28 Please see the file named INSTALL.txt for installation instructions.
  29
  30 Usage
  31 -----
  32
  33 Anagram can be used from command line as well as through a graphical
  34 interface.
  35
  36 Enter 'anagram -h' in the command line to see a list of available
  37 options and usage instructions.
  38
  39 anagram [-hmpP] word [word2]
  40
  41          The program finds the possible angrams of the 'word' from a dictionary.
  42          If 'word2' is specified it compares 'word' and 'word2' to check if they are anagrams of each other.
  43 Options:
  44 -h       Show this help
  45 -m       Find multiword anagrams
  46 -p       Checks if 'word' is a palindrome
  47 -P       Only checks if 'word' is a palindrome. Does not find angrams.
  48
  49 Example:
  50          anagram -p cat
  51
  52
  53 To start the graphical interface launch the binary file named 'angramx'.
  54
  55 Licensing
  56 ---------
  57
  58 Copyright (c) 2013-2015 Agnibho Mondal
  59 All rights reserved
  60
  61 This file is part of Anagram.
  62
  63 Anagram is free software: you can redistribute it and/or modify
  64 it under the terms of the GNU General Public License as published by
  65 the Free Software Foundation, either version 3 of the License, or
  66 (at your option) any later version.
  67
  68 Anagram is distributed in the hope that it will be useful,
  69 but WITHOUT ANY WARRANTY; without even the implied warranty of
  70 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  71 GNU General Public License for more details.
  72
  73 You should have received a copy of the GNU General Public License
  74 along with Anagram.  If not, see <http://www.gnu.org/licenses/>.
  75
  76 Contacts
  77 --------
  78
  79 Agnibho Mondal
  80 mail@agnibho.com
  81 www.agnibho.com