<commit_before>FindFile for Windows, Linux, and Mac
====================================

FindFile is a handy, cross-platform portable, standalone command line file searching utility using non-indexed search only. It is similar to a combination of the find and grep commands in Linux. This is needed because both find and grep are not specifically designed for searching files.

FindFile is not meant to replace the Linux find and grep commands, or any other comparable commands, because each program excels in their own niche.

FindFile was developed out of a need to search for local files quickly from the command line. It seems like existing tools cannot do what I needed to do. I first started out using the Windows FIND command, then realized that it cleverly skipped over binary files, including XML files with a unicode header, and hence did not return the search results I needed. This could be a problem if you rely on its results for some business. Therefore I set out to develop a simple program to search for files, starting from about 50 lines of code, and then it became what it is today.

### Getting Started

FindFile is designed to be extremely easy to install and use. Follow these steps to get yourself started using it:

1. Download FindFile (from below).
2. Unzip it to extract the executable file.
3. Put the executable file in your PATH, or add its location to your PATH environment variable.
4. Open a terminal / command prompt / powershell prompt.
5. Run `ff -h` or `ff --help`.
6. Run `ff -?` or `ff --info` (or view it [online] (https://github.com/choksheak/findfile/blob/master/INFO.txt)). Use `ff -? | less` if you have `less` on your machine (Linux, or GnuWin32).
7. Run `ff hello world` to search for the strings `hello` and `world` from your current directory.

### Download Latest Release

The releases are in the form of a single, standalone executable file only. This means that you do not need to install any supporting libraries in order to run the program. But note that the flip side of this is that these executables tend to be larger than what you would find in other native executables because they have to bake in all the supporting libraries into one file.<commit_msg>Add platform names to README text<commit_after>FindFile for Windows, Linux, and Mac
====================================

FindFile is a handy, cross-platform portable, standalone command line file searching utility using non-indexed search only. It works the same way across Windows, Linux, and Mac, and any other platform or operating system supported by the Go language. FindFile is similar to a combination of the find and grep commands in Linux. This is needed because both find and grep are not specifically designed for searching through files.

FindFile is not meant to replace the Linux find and grep commands, or any other comparable commands, because each program excels in their own niche.

FindFile was developed out of a need to search for local files quickly from the command line. It seems like existing tools cannot do what I needed to do. I first started out using the Windows FIND command, then realized that it cleverly skipped over binary files, including XML files with a unicode header, and hence did not return the search results I needed. This could be a problem if you rely on its results for some business. Therefore I set out to develop a simple program to search for files, starting from about 50 lines of code, and then it became what it is today.

### Getting Started

FindFile is designed to be extremely easy to install and use. Follow these steps to get yourself started using it:

1. Download FindFile (from below).
2. Unzip it to extract the executable file.
3. Put the executable file in your PATH, or add its location to your PATH environment variable.
4. Open a terminal / command prompt / powershell prompt.
5. Run `ff -h` or `ff --help`.
6. Run `ff -?` or `ff --info` (or view it [online] (https://github.com/choksheak/findfile/blob/master/INFO.txt)). Use `ff -? | less` if you have `less` on your machine (Linux, or GnuWin32).
7. Run `ff hello world` to search for the strings `hello` and `world` from your current directory.

### Download Latest Release

The releases are in the form of a single, standalone executable file only. This means that you do not need to install any supporting libraries in order to run the program. But note that the flip side of this is that these executables tend to be larger than what you would find in other native executables because they have to bake in all the supporting libraries into one file.
{'fraction_non_alphanumeric': 0.06191410507957271, 'fraction_numerical': 0.004796163069544364, 'mean_word_length': 4.213636363636364, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1287101', 'n_tokens_mistral': 1106, 'n_tokens_neox': 1065, 'n_words': 753}