Skip to content

Commit

Permalink
added natlang2latex tutorial readme (#20)
Browse files Browse the repository at this point in the history
* added Natlang2latex tutorial to readme

* exclude readme file in black lint
  • Loading branch information
polskiTran authored Mar 30, 2024
1 parent c48e498 commit 5e217b2
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
19 changes: 15 additions & 4 deletions projects/NatLang2Latex/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,31 @@
# NatLang2Latex

## Setup
This is a simple natural language to LaTex converter using Google Gemini

Either use the devcontainer included, or have `poetry` installed. Navigate to the root of the project and run
## Usage

1. Either use the devcontainer included, or have `poetry` installed. Navigate to the root of the project and run

```terminal
poetry install
```

Then obtain a Google API key, create a `.env` file and fill it in based on the example in `.env.example`. If you want to contribute, you can also run the following set of commands.
2. Obtain a Google API ke from [Google dev AI](https://ai.google.dev/), create a `.env` file and fill it in based on the example in `.env.example`. If you want to contribute, you can also run the following set of commands.

```terminal
poetry install --with dev
poetry run pre-commit install
```

3. Run the application using the following command

```terminal
poetry run streamlit run main.py
```

which should open up the application locally hosted in your default browser

![image](resources/homepage.png)

## Tests

Run tests with
Expand Down
3 changes: 3 additions & 0 deletions projects/NatLang2Latex/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,6 @@ pytest = "^8.1.1"
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

[tool.black]
extend-exclude = "^/projects/natlang2latex/README.md"
Binary file added projects/NatLang2Latex/resources/homepage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5e217b2

Please sign in to comment.