aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLibravatar SR Tamim <saifur.rahman.tamim1@gmail.com>2024-03-07 01:47:33 +0600
committerLibravatar SR Tamim <saifur.rahman.tamim1@gmail.com>2024-03-07 01:47:33 +0600
commite50af66f8193d933098989a7400b5dfcc1a81dd8 (patch)
treef61355422194d50ae15c5a43f7d938e238d48d13
parenta8aa863d7e9732dc65f86bb3f4cbdd243e6ad6da (diff)
downloadentropy-calc-e50af66f8193d933098989a7400b5dfcc1a81dd8.tar.gz
entropy-calc-e50af66f8193d933098989a7400b5dfcc1a81dd8.zip
Add README.md file with project information
-rw-r--r--README.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..73b3717
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# Entropy Calculator
+
+This is a C++ project that calculates the entropy change of different elements in specified temparature difference.
+
+## Project Structure
+
+- `main.cpp`: The entry point of the application.
+- `elements/`: This directory contains the definition of different elements.
+- `headers/`: This directory contains the header files for the project.
+- `bin/`: This directory contains the compiled binaries.
+- `obj/`: This directory contains the object files generated during compilation.
+
+## How to Build
+
+1. Open the `entropy-calculator.cbp` file in Code::Blocks.
+2. Click on the "Build" button or select "Build" from the "Build" menu.
+
+## How to Run
+
+After building the project, you can run the program by clicking on the "Run" button or selecting "Run" from the "Build" menu in Code::Blocks.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/) \ No newline at end of file