Skip to content

Commit

Permalink
Merge pull request #39 from rlcaust/Jahmilli-patch-1
Browse files Browse the repository at this point in the history
updated readme on running the program
  • Loading branch information
JaydenL33 authored Jun 7, 2019
2 parents e31fd9d + 068f624 commit 7e80b33
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,19 @@
## Running the Application
The application is runnable per environment. Simply use the included makefile to clean, recompile all or recompile libraries.
__Note:__ The application requires $LINES and $COLUMNS to be available to the program.
To enable this, run: `export LINES=$LINES;export COLUMNS=$COLUMNS`
In your terminal, run:
```
export LINES=$LINES; export COLUMNS=$COLUMNS
make clean && make all
./main.out h # Displays the help menu
./main.out g # Prints raindrops using a random string
```

### *Using make:*
* `make clean`, cleans all .o, .a and program generated files created during the compile process.
* `make all`, compiles all libraries and links them to the implementer (main.c).
* `make libraries`, compiles all libraries but doesn't link them, this is useful for debugging purposes. Otherwise, in typical use, simply call make all.

### *Chaining commands:*
* The usual double-ampersand (&&) used in bash allows chaining makefile commands;
`make clean && make all`

0 comments on commit 7e80b33

Please sign in to comment.