README

SEARCH ENGINE PROJECT

A small program for demonstration purpose. It indexes texts from files and provide way for the users to search through those indexed files.

CLI-only version:
    + Prerequisite: (satisfied on almost any linux systems)
        g++
        glibcxx
    + Compilation:
        g++ -Wall -O3 -std=c++0x *.cpp -o search-engine
    + Run:
        ./search-engine
GUI version:
    + Prerequisite: (can be easily installed with qt4-dev-tools package on ubuntu)
        g++
        glibcxx
        cmake
        libqt4-dev
    + Compilation:
        mkdir build && cd build
        cmake ..
        make
    + Run
        ./search-engine (in build directory)

CLI Manual (can apply for GUI version):
Running:
    search-engine [--option [<argument>]] <files_to_index>
Provide all file names as commandline arguments for the program
Eg: search-engine file1.txt file2.txt
    search-engine documents/*     (for indexing every files inside 'documents' directory)
    
Stop the program:
    Use "." (dot) as the query

Program's option:
--stop-words-file <path/to/file>
    specify stop words list file. Default file: "./stopwords"
--no-gui (for GUI version)
    run without GUI
--help
    show this manual