Skip to content

Commit

Permalink
Additions to README.md
Browse files Browse the repository at this point in the history
Added a table of contents, installment, running the command, and license sections.
  • Loading branch information
CarterGrove24 authored Jun 14, 2022
1 parent 4f5c196 commit ea7f43a
Showing 1 changed file with 32 additions and 5 deletions.
37 changes: 32 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,33 @@
# **E4s-Info Commands**
# **E4S-Info Commands**
*A collection of command line tools that inform and educate E4S users*

### Problem Statement
## Table of Contents
- [Problem Statement](https://github.com/Collegeville/e4s-info#problem-statement)
- [Requirements](https://github.com/Collegeville/e4s-info#requirements)
- [Design Details Overview](https://github.com/Collegeville/e4s-info#design-details-overview)
- [Specific Design Details](https://github.com/Collegeville/e4s-info#specific-design-details)
- [Installment](https://github.com/Collegeville/e4s-info#installment)
- [Running the Command](https://github.com/Collegeville/e4s-info#running-the-command)
- [License](https://github.com/Collegeville/e4s-info#license)

## Problem Statement
*E4S should have a interesting, interactive way to learn more about who, what, where, why, and how the E4S Software was built.*

### Requirements
## Requirements
- Must be easily buildable by the E4S Software
- Must have few/zero dependencies
- Must be a command that can run from the terminal
- Must be able to take the index of the answer as a parameter if a datafile is specified

### Design Details Overview
## Design Details Overview
The software is a command that is available to run in the termianl. The command is built on bash script to reduce dependencies. Heavy influences on design choices were the fortune command that runs in the terminal and other fortune commands available on GitHub.
- fortune command in VMWare Terminal
- why command in MatLab
- [shlomif/fortune-mod]
- [ruanyf/fortunes]
- [bmc/fortunes]

### Specific Design Details
## Specific Design Details
- **Datafile**
- Use the character \"\%\" as a delimiter
- This decision was made by looking at the fortune codes on GitHub
Expand All @@ -38,6 +47,24 @@ The software is a command that is available to run in the termianl. The command
- 1 if invalid option is provided
- 2 if datafile cannot be found

## Installment
Please visit [INSTALL.md](INSTALL.md) to view the installation instructions.

## Running the Command
- No Arguments
- Example: `e4s-info`
- Result: Prints a randomly selected entry from a randomly selected data file
- One Argument
- Example: `e4s-info how`
- Result: Prints a randomly selected entry from the specified data file, in this case the how.data file
- Two Arguments
- Example: `e4s-info why -2`
- Result: Prints the third entry from the specified data file, in this case the third entry from the why.data file

## License
Please visit [LICENSE](LICENSE) to view the license for this repository.



[//]: #

Expand Down

0 comments on commit ea7f43a

Please sign in to comment.