Skip to content

Commit

Permalink
Updated README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
Noah-Everett committed Jul 12, 2022
1 parent bebaaed commit 168dceb
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
# Base

Base is a program builder. It contains scripts and classes to make creating programs much easier.
Base is a general library that contains classes and scripts to make creating programs easier and better.

## Contents
```
src/
Input/ # contains classes that handle program inputs
Output/ # contains classes that handle program's output
NonFloatingPoint/ # contains classes of numerical data types that are non-floating points
setup_base.sh # setup Base to be used by other programs
make_main.sh # script to generate a main.cpp file preconfigured to use Base
src/ # contains all source code (hpp and cpp files)
CmdLnArgParser/ # class for command line argument/option parsing
Messenger/ # class for program messaging
OS/ # OS related functions
Rational/ # class for non-floating point real numbers
setup_base.sh # setup Base to be used by other programs
make_main.sh # script to generate a main.cpp file preconfigured to use Base
```

[//]: # (## Use Base with CMake Project)

0 comments on commit 168dceb

Please sign in to comment.