Skip to content

Commit 593991a

Browse files
authored
Samuel100/readme patch (#150)
* updates to readme * change to tip * fix tip formatting * fix link
1 parent 7de6571 commit 593991a

File tree

1 file changed

+78
-7
lines changed

1 file changed

+78
-7
lines changed

README.md

Lines changed: 78 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,16 @@ Foundry Local brings the power of Azure AI Foundry to your local device **withou
3030
```bash
3131
winget install Microsoft.FoundryLocal
3232
```
33-
For any issues, refer to the [Installation section](https://github.com/microsoft/Foundry-Local#installing) below.
3433
- **MacOS**: Open a terminal and run the following command:
3534
```bash
3635
brew tap microsoft/foundrylocal
3736
brew install foundrylocal
3837
```
3938
Alternatively, you can download the installer from the [releases page](https://github.com/microsoft/Foundry-Local/releases) and follow the on-screen installation instructions.
4039

40+
> [!TIP]
41+
> For any issues, refer to the [Installation section](#installing) below.
42+
4143
2. **Run your first model**: Open a terminal and run the following command to run a model:
4244

4345
```bash
@@ -165,15 +167,25 @@ async function streamCompletion() {
165167
streamCompletion();
166168
```
167169
168-
## Installing
170+
## Manage
171+
172+
This section provides an overview of how to manage Foundry Local, including installation, upgrading, and removing the application.
173+
174+
### Installing
175+
176+
Foundry Local is available for Windows and macOS (Apple silicon only). You can install it using package managers or manually download the installer.
169177
170-
### Windows
178+
#### Windows
171179
172-
Install Foundry Local using `winget install Microsoft.FoundryLocal` in a Windows console (PowerShell, cmd, etc.)
180+
Install Foundry Local using the following command in a Windows console (PowerShell, cmd, etc.):
173181
174-
You can also manually download and install the packages. On [the releases page](https://github.com/microsoft/Foundry-Local/releases)
175-
select a release and expand the Artifacts list. Copy the artifact full URI (like `https://github.com/microsoft/Foundry-Local/releases/download/v0.3.9267/FoundryLocal-x64-0.3.9267.43123.msix`)
176-
to use in the below PowerShell steps. (Replace `x64` with `arm64` as needed.)
182+
```bash
183+
winget install Microsoft.FoundryLocal
184+
```
185+
186+
Alternatively, you can also manually download and install the packages. On [the releases page](https://github.com/microsoft/Foundry-Local/releases)
187+
select a release and expand the Artifacts list. Copy the artifact full URI (for example: `https://github.com/microsoft/Foundry-Local/releases/download/v0.3.9267/FoundryLocal-x64-0.3.9267.43123.msix`)
188+
to use in the below PowerShell steps. Replace `x64` with `arm64` as needed.
177189
178190
```powershell
179191
# Download the package and its dependency
@@ -201,6 +213,65 @@ and include logs using one of these methods:
201213
> Log files may contain information like user names, IP addresses, file paths, etc. Be sure to remove those
202214
> before sharing here.
203215
216+
#### macOS
217+
218+
Install Foundry Local using the following commands in your terminal:
219+
220+
```bash
221+
brew tap microsoft/foundrylocal
222+
brew install foundrylocal
223+
```
224+
225+
Alternatively, you can also manually download and install the packages by following these steps:
226+
227+
1. Download the latest release from [the releases page](https://github.com/microsoft/Foundry-Local/releases).
228+
1. Unzip the downloaded file.
229+
1. Open a terminal and navigate to the unzipped folder, run the following command to install Foundry Local:
230+
231+
```bash
232+
./install-foundry.command
233+
```
234+
235+
### Upgrading
236+
237+
To upgrade Foundry Local, run the following command in your terminal:
238+
239+
- **Windows**
240+
```bash
241+
winget upgrade --id Microsoft.FoundryLocal
242+
```
243+
244+
- **macOS**:
245+
If you installed Foundry Local using Homebrew, you can upgrade it with the following command:
246+
```
247+
brew upgrade foundrylocal
248+
```
249+
If you installed Foundry Local manually, you'll first need to uninstall the current version using:
250+
```bash
251+
uninstall-foundry
252+
```
253+
Then, follow the [installation instructions](#installing) to install the latest version.
254+
255+
### Uninstalling
256+
To uninstall Foundry Local, run the following command in your terminal:
257+
258+
- **Windows**: You can uninstall Foundry Local using `winget` in a Windows console (PowerShell, cmd, etc.):
259+
```bash
260+
winget uninstall Microsoft.FoundryLocal
261+
```
262+
Alternatively, you can also uninstall Foundry Local by navigating to **Settings > Apps > Apps & features** in Windows, finding "Foundry Local" in the list, and selecting the ellipsis (`...`) followed by **Uninstall**.
263+
264+
- **macOS**: If you installed Foundry Local using Homebrew, you can uninstall it with the following command:
265+
```bash
266+
brew rm foundrylocal
267+
brew untap microsoft/foundrylocal
268+
brew cleanup --scrub
269+
```
270+
If you installed Foundry Local manually, you can uninstall it by running the following command in your terminal:
271+
```bash
272+
uninstall-foundry
273+
```
274+
204275
## Features & Use Cases
205276
206277
- **On-device inference** - Process sensitive data locally for privacy, reduced latency, and no cloud costs

0 commit comments

Comments
 (0)