source: README.txt @ f6c467d

Last change on this file since f6c467d was f6c467d, checked in by Agnibho Mondal <mail@…>, 4 years ago

Rewritten in C++

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