Skip to content

Commit

Permalink
[SM-1399] Update the README for Windows on ARM (#942)
Browse files Browse the repository at this point in the history
## ๐ŸŽŸ๏ธ Tracking

https://bitwarden.atlassian.net/browse/SM-1399

## ๐Ÿ“” Objective

Just `cargo build` is not sufficient for building the SDK on Windows on
ARM. We should add clarity to what is required so that `cargo build`
will run successfully.

Python is required. Clang is also required for
[ring](https://crates.io/crates/ring) (more info
[here](https://github.com/briansmith/ring/blob/main/BUILDING.md)).

## โฐ Reminders before review

- Contributor guidelines followed
- All formatters and local linters executed and passed
- Written new unit and / or integration tests where applicable
- Protected functional changes with optionality (feature flags)
- Used internationalization (i18n) for all UI strings
- CI builds passed
- Communicated to DevOps any deployment requirements
- Updated any necessary documentation (Confluence, contributing docs) or
informed the documentation
  team

## ๐Ÿฆฎ Reviewer guidelines

<!-- Suggested interactions but feel free to use (or not) as you desire!
-->

- ๐Ÿ‘ (`:+1:`) or similar for great changes
- ๐Ÿ“ (`:memo:`) or โ„น๏ธ (`:information_source:`) for notes or general info
- โ“ (`:question:`) for questions
- ๐Ÿค” (`:thinking:`) or ๐Ÿ’ญ (`:thought_balloon:`) for more open inquiry
that's not quite a confirmed
  issue and could potentially benefit from discussion
- ๐ŸŽจ (`:art:`) for suggestions / improvements
- โŒ (`:x:`) or โš ๏ธ (`:warning:`) for more significant problems or
concerns needing attention
- ๐ŸŒฑ (`:seedling:`) or โ™ป๏ธ (`:recycle:`) for future improvements or
indications of technical debt
- โ› (`:pick:`) for minor or nitpick changes
  • Loading branch information
coltonhurst committed Aug 8, 2024
1 parent b8a024f commit 6e65f97
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,21 @@ are currently open as well as what it's like to work at Bitwarden.

## Getting Started

### Linux / Mac / Windows

```bash
cargo build
```

### Windows on ARM

To build, you will need the following in your PATH:

- [Python](https://www.python.org)
- [Clang](https://clang.llvm.org)
- We recommend installing this via the
[Visual Studio Build Tools](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022)

## Crates

The project is structured as a monorepo using cargo workspaces. Some of the more noteworthy crates
Expand Down

0 comments on commit 6e65f97

Please sign in to comment.