Skip to content

Commit

Permalink
fix: issue NM-TAFE#47 - Wikilink Installation Guide. Link to guide fr…
Browse files Browse the repository at this point in the history
…om readme.md corrected as is the wiki link below it. Updated: Readme.md with final steps of basic installation that were lacking
  • Loading branch information
Isaac-Saleh committed Jun 13, 2024
1 parent 3852ae8 commit aa2d37a
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Installation-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Change into the project directory.

```bash

cd project-advanced-ui-developmennt-team-mental-capacity/
cd dip-programming-prj-advanced-gui-awesome.git

```

Expand Down
40 changes: 37 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ The program reads code from videos to assist visually impaired developers in usi

## Installation

To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/dip-project-ocrroo/wiki/Installation-Guide)
in the [Wiki](https://github.com/NM-TAFE/dip-project-ocrroo/wiki).
To install and run this project, please follow the [Installation Guide](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-awesome/wiki/Installation-Guide)
in the [Wiki](https://github.com/NM-TAFE/dip-programming-prj-advanced-gui-awesome/wiki).

#### Basic Installation

Expand Down Expand Up @@ -66,7 +66,41 @@ source venv/bin/activate
pip install -r requirements.txt
```

5. ...rest of installation steps here
5. Navigate to App Directory

Change into app directory.

```bash
cd app/

```

6. Run the Application

To run the application with silenced debug/logging output, execute the following command. Debug and logging outputs will be saved to an `app.log` file

```bash
python app.py

```

To run the application with debug/logging output in the console, use the following command.This is recommended for development as it automatically reloads the app when changes are detected.

```bash
flask run --debug

```

#### Configuration Variables

To use the project, add the following configuration variables to your `config.ini` file:

- `openai_api_key`: API key for OpenAI
- `tesseract_executable`: Path to Tesseract OCR executable
- `ide_executable`: Path to preferred IDE executable

In the current version of the project, this manual configuration is necessary.However, future builds will allow you to perform this configuration from the user interface (UI).


## Contributing

Expand Down

0 comments on commit aa2d37a

Please sign in to comment.