From 11614b6d84e4df588b31f0206b912b8f55934c98 Mon Sep 17 00:00:00 2001 From: Bruce MacDonald Date: Tue, 27 Jun 2023 13:46:46 -0400 Subject: [PATCH] add development doc --- README.md | 4 ++++ docs/development.md | 51 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 docs/development.md diff --git a/README.md b/README.md index 56ba76b9..0bbf6139 100644 --- a/README.md +++ b/README.md @@ -80,3 +80,7 @@ In the future, there will be an easy CLI for running models ollama run huggingface.co/thebloke/llama-7b-ggml > Downloading [================> ] 66.67% (2/3) 30.2MB/s ``` + +## Documentation + +- [Development](docs/development.md) diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 00000000..a0b37e11 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,51 @@ +# Development + +## Running + +Install dependencies: + +``` +pip install -r requirements.txt +``` + +Put your model in `models/` and run: + +``` +python3 ollama.py serve +``` + +To run the app: + +``` +cd desktop +npm install +npm start +``` + +## Building + +If using Apple silicon, you need a Python version that supports arm64: + +```bash +wget https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-MacOSX-arm64.sh +bash Miniforge3-MacOSX-arm64.sh +``` + +Get the dependencies: + +```bash +pip install -r requirements.txt +``` + +Then build a binary for your current platform: + +```bash +python3 build.py +``` + +### Building the app + +``` +cd desktop +npm run package +```