Skip to content

Commit

Permalink
WIP README.txt
Browse files Browse the repository at this point in the history
  • Loading branch information
angrave committed Feb 6, 2025
1 parent c1e4ec6 commit f1da56b
Showing 1 changed file with 31 additions and 5 deletions.
36 changes: 31 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,37 @@
# latex_transcribe
# Latex Transcribe

Local setup (without docker) using python 3.11
````
# We use python3.11. These instructions mirror the steps in Dockerfile
## Running the official DockerHub image

(This is sketch and these instructions are untested - assume there are typos, errors, guesses (e.g. Port number), and ommissions that need to be fixed)

docker pull classtranscribe/latextranscribe:latest

docker run -i -p 8080:8080 -t latextranscribe

## Building Locally

### Local build with Docker

(This is sketch and these instructions are untested - assume there are typos, errors, guesses, and ommissions that need to be fixed)

docker build -t latextranscribe
docker run -i -p 8080:8080 -t latextranscribe


### Local build without docker

(This is sketch and these instructions are untested - assume there are typos, errors, guesses, and ommissions that need to be fixed)


Assuming you have python3.11 installed. Note these instructions essentialy mirror the steps in Dockerfile.

````sh
python3.11 -m venv venv
source ./venv/bin/activate

pip install --upgrade pip
pip install -r requirements.txt
````
Hmm todo

````

0 comments on commit f1da56b

Please sign in to comment.