Browse Source

add development doc

Bruce MacDonald 1 year ago
parent
commit
11614b6d84
2 changed files with 55 additions and 0 deletions
  1. 4 0
      README.md
  2. 51 0
      docs/development.md

+ 4 - 0
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)

+ 51 - 0
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
+```