Skip to content

Commit

Permalink
Elaborate in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
leonmavr committed Dec 5, 2023
1 parent baf14e6 commit cf02339
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Expand Up @@ -63,6 +63,9 @@ The demo executable that runs the UI will be generated at
```
That's it, have fun doing RPN calculations!

A unit test executable is also generated at
`./build/test/testhip35`.

## The keys

Most keys are self-explanatory. However, some are less straightforward.
Expand All @@ -88,13 +91,9 @@ not captured so `q` is the only way to quit. You can read more
at the [HP35 manual](https://literature.hpcalc.org/community/hp35-om-en-reddot.pdf)
[[4]](#ref-4).

A unit test executable is also generated at
`./build/test/testhip35`.

### Project directory structure and source code

Implementations are found at `lib/src` and header files at `lib/src`.
Unit tests are found at `test/test.cpp`.
Implementations are found at `lib/src` and header files at `lib/inc`. The demo application is at `demo/main.cpp` and unit tests are found at `test/test.cpp`.

You can create an instance of the Hip35 class and run it either via
the UI or without it (given a string) as follows:
Expand Down

0 comments on commit cf02339

Please sign in to comment.