diff --git a/README.md b/README.md index 50d8f6bd2..e2771016a 100644 --- a/README.md +++ b/README.md @@ -59,19 +59,53 @@ Before you begin, ensure you have the following installed: ## Setup -1. Clone the repository (if you haven't already): +Many of you are new users to installing software from Github. Below are instructions for Mac users. PC users may be able to follow the instructions below as well. If you have any installation troubles reach out and submit an "issue" using the links above, or feel free to enhance this documentation by forking, editing the instructions, and doing a pull request. -```bash +1. Install Git from https://git-scm.com/downloads + +2. Install Node.js from https://nodejs.org/en/download/. Pay attention to the installer notes after completion. On a Mac, it will tell you to check if /usr/local/bin is in your $PATH. To determine if usr/local/bin is included in $PATH open your Terminal and run + +``` +echo $PATH . +``` + +If you see usr/local/bin in the output then you're good to go. + +3. Clone the repository (if you haven't already) by opening a Terminal window (or CMD with admin permissions) and then typing in this: + +``` git clone https://github.com/coleam00/bolt.new-any-llm.git ``` -2. Install dependencies: +4. Install dependencies using Terminal (or CMD in Windows with admin permissions): -```bash +``` pnpm install ``` -3. Rename `.env.example` to .env.local and add your LLM API keys (you only have to set the ones you want to use and Ollama doesn't need an API key because it runs locally on your computer): +If you get an error saying "command not found: pnpm" or similar, then that means pnpm isn't installed. You can install it via this: + +``` +sudo npm install -g pnpm +``` + +5. Rename .env.example to .env.local and add your LLM API keys. You will find this file on a Mac at "[your name]/bold.new-any-llm/.env.example" + +![image](https://github.com/user-attachments/assets/7e6a532c-2268-401f-8310-e8d20c731328) + +If you can't see the file indicated above, its likely you can't view hidden files. On Mac, open a Terminal window and enter this command below. On Windows, you will see the hidden files option in File Explorer Settings. A quick Google search will help you if you are stuck here. + +``` +defaults write com.apple.finder AppleShowAllFiles YES +``` + +**NOTE**: you only have to set the ones you want to use and Ollama doesn't need an API key because it runs locally on your computer: + +Get your GROQ API Key here: https://console.groq.com/keys + +Get your Open AI API Key by following these instructions: https://help.openai.com/en/articles/4936850-where-do-i-find-my-openai-api-key + +Get your Anthropic API Key in your account settings: https://console.anthropic.com/settings/keys ``` GROQ_API_KEY=XXX