Skip to content

Commit 8548e73

Browse files
author
bniladridas
committed
Update README with installation instructions and dependencies
1 parent 3b85246 commit 8548e73

File tree

1 file changed

+41
-2
lines changed

1 file changed

+41
-2
lines changed

README.md

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,47 @@ To better understand the data received during execution, logging statements have
101101
### Issue Resolution
102102
An issue was identified where an invalid character in the JSON payload caused errors during execution. This was resolved by properly escaping newline characters in the payload. The application is now functioning correctly, and responses are generated as expected.
103103

104+
## Installation Instructions
105+
106+
To set up the Llama C++ Terminal Application, follow these steps:
107+
108+
### Prerequisites
109+
- Ensure you have the necessary build tools installed, such as CMake and Make.
110+
111+
### Dependencies
112+
- The following packages are required:
113+
- `libcurl4-openssl-dev`
114+
- `libncurses-dev`
115+
- `libtinfo6`
116+
117+
### Setting Up the Development Environment
118+
1. Clone the repository:
119+
```bash
120+
git clone https://github.com/bniladridas/cpp_terminal_app.git
121+
cd cpp_terminal_app
122+
```
123+
2. Update the package lists and install dependencies:
124+
```bash
125+
sudo apt-get update
126+
sudo apt-get install -y libcurl4-openssl-dev libncurses-dev libtinfo6
127+
```
128+
3. Set up CUDA (if applicable):
129+
- Follow the instructions in the workflow for setting up CUDA.
130+
131+
### Building the Application
132+
- To build the application, run:
133+
```bash
134+
mkdir build && cd build
135+
cmake ..
136+
make
137+
```
138+
139+
### Running Tests
140+
- To run the tests, execute:
141+
```bash
142+
ctest
143+
```
144+
104145
## Acknowledgments
105146

106147
- **Llama Model**: Developed by Meta, the Llama model is a state-of-the-art language model designed for advanced natural language processing tasks.
@@ -214,5 +255,3 @@ sudo apt-get update && sudo apt-get install -y libcurl4-openssl-dev && cmake -S
214255
```bash
215256
mkdir build && cd build && cmake .. && make && ./LlamaTerminalApp
216257
```
217-
218-

0 commit comments

Comments
 (0)