Skip to content

Commit

Permalink
readme: add usage example
Browse files Browse the repository at this point in the history
  • Loading branch information
budchirp committed May 11, 2024
1 parent 8944a36 commit bf7c0ee
Show file tree
Hide file tree
Showing 7 changed files with 50 additions and 12 deletions.
19 changes: 13 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,6 @@ modules.order
Module.symvers
Mkfile.old
dkms.conf
.idea
*.iml
out
gen
.idea/**/workspace.xml
.idea/**/tasks.xml
.idea/**/usage.statistics.xml
Expand All @@ -59,7 +55,7 @@ gen
.idea/**/libraries
cmake-build-*/
.idea/**/mongoSettings.xml
*.iwss
*.iws
out/
.idea_modules/
atlassian-ide-plugin.xml
Expand All @@ -70,4 +66,15 @@ crashlytics.properties
crashlytics-build.properties
fabric.properties
.idea/httpRequests
.idea/caches/build_file_checksums.ser
.idea/caches/build_file_checksums.ser
CMakeLists.txt.user
CMakeCache.txt
CMakeFiles
CMakeScripts
Testing
Makefile
cmake_install.cmake
install_manifest.txt
compile_commands.json
CTestTestfile.cmake
_deps
8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions .idea/calcplusplus.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions .idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions .idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/vcs.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
<div align="center">
<h1>calcplusplus</h1>
</div>
<h1 align="center">calcplusplus</h1>
<h2 align="center">TUI calculator written in C++ using FTXUI</h2>

<p align="center">
<div align="center">
<img alt="Stargazers" src="https://img.shields.io/github/stars/budchirp/calcplusplus?style=for-the-badge&colorA=0b1221&colorB=ff8e8e" />
<img alt="Last commit" src="https://img.shields.io/github/last-commit/budchirp/calcplusplus?style=for-the-badge&colorA=0b1221&colorB=BDB0E4" />
<img alt="Issues" src="https://img.shields.io/github/issues/budchirp/calcplusplus?style=for-the-badge&colorA=0b1221&colorB=FBC19D" />
</p>
</div>


## 💾 Installation

### Requirements

1. C compiler
2. CMake
2. CMake & Make

### How to install?

Expand All @@ -34,3 +33,7 @@ cmake ../ && make -j$(nproc)
> NOTE: If you're using fish, remove the `$` sign.
3. Have fun!

```sh
./build/calcplusplus
```

0 comments on commit bf7c0ee

Please sign in to comment.