From d070061b0c796735d96d5787e5e383ab71aa0518 Mon Sep 17 00:00:00 2001 From: didyouexpectthat Date: Sun, 23 Apr 2023 15:50:01 -0700 Subject: [PATCH] Create a README file --- README.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ae925e8..138a787 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -Frequency Calculator - -This is a simple frequency calculator that can be used to calculate the frequency of a given word in a given text. It is written in C++. Originally created as a grocery analyzer, this calculator was created using Visual Studio 2019 Community Edition. +**Frequency Calculator** +--- +This is a simple frequency calculator that can be used to calculate the frequency of a given word in a given text. It is written in C++. Originally created as a grocery analyzer, this calculator was created using Visual Studio 2019 Community Edition. +-- The program works by taking in a text file where each line is a unique, one-word string. These strings are counted and output into a file called frequency.dat. Afterwards, the program allows you to visualize the data in two ways: first, simply the string with the frequency; second, a histogram of stars. + Some ease-of-life functions include allowing the user to input the name of a file to use if the default file is not found, and color coding to separate user input and important output from standard output. In this program, some things I did particularly well were documenting the different sections of code. I kept the comments short enough to not be distracting, and if you follow the comment lines, one could easily read through the story of the program. I did a good job at keeping the code readable and maintainable, and I think that the code is very adaptable to other projects with additional features which are unused in the example. @@ -17,4 +19,8 @@ The most challenging part of the code was writing the histogram function. It was File manipulation is a very important skill to have in the field of computer science. I will be able to use this skill in many different projects in the future. I currently work on reports and do them by hand but I can automate them since most of it is copy/pasting work. File manipulation learned here helps me process the data more efficiently. -The code is readable and maintainable because I used standard layout and naming conventions. I used comments to explain what each section of code does. I tried to keep the amount of code as small as possible to uncomplicate it. \ No newline at end of file +The code is readable and maintainable because I used standard layout and naming conventions. I used comments to explain what each section of code does. I tried to keep the amount of code as small as possible to uncomplicate it. + +Cody Cook +Southern New Hampshire University +CS-210-T4133 Programming Languages 23EW4