Skip to content

Commit

Permalink
Merge pull request #135 from brown-ccv/ref-prerequisites
Browse files Browse the repository at this point in the history
docs: Remove Visual Studio as a prerequisite for Honeycob
  • Loading branch information
RobertGemmaJr authored May 7, 2024
2 parents 3457096 + e31b996 commit 12deaa0
Show file tree
Hide file tree
Showing 3 changed files with 408 additions and 420 deletions.
21 changes: 0 additions & 21 deletions docs/prerequisites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,6 @@ It is important that your computer is set up with the necessary packages before

[Python](https://www.python.org) is a high-level programming language. Some "under the hood" tools needed by Honeycomb are written in python so it must be installed on your system.

:::danger
Honeycomb **cannot** use Python version 3.12 or newer. The installers will install version 3.11.
:::

### Oracle JDk

[Java](https://www.oracle.com/java/) is another high-level programming language that some tools are written in (namely, the Firebase Emulators). We must install a JDK (Java Development Kit) for it to run.
Expand All @@ -53,16 +49,6 @@ Honeycomb needs Java version 11 or later to run - the installers use version 18.

Rosetta is a translation layer built for Mac computers with Apple Silicon. It should ask to be installed if any of the prerequisite tools need it. Otherwise, [this guide](https://support.apple.com/en-us/HT211861) can be used to make sure it is on your Apple Silicon system.

## Windows-specific Install

### Visual Studio

[Visual Studio](https://visualstudio.microsoft.com) is a special IDE for the Windows platform. It comes with everything needed to compile desktop applications from a PC. Visual Studio Community is free to use.

:::caution
The "Desktop development with C++" workload must also be installed with Visual Studio. The automated installers should preselect this but you should double check to be certain!
:::

## Manual Installation

### macOS
Expand All @@ -87,9 +73,6 @@ The links below will take you to each project installation page should you prefe
- [Python](https://www.python.org/downloads/windows/)
- [Oracle JDK](https://www.oracle.com/java/technologies/downloads/#jdk20-mac)
- [VS Code](https://code.visualstudio.com/download)
- Visual Studio:
- [Visual Studio 2022 Community](https://visualstudio.microsoft.com/vs/community/)
- Install the [Native C++ Workflow](https://docs.microsoft.com/en-us/cpp/build/vscpp-step-0-installation?view=msvc-160#step-4---choose-workloads-1)

### Linux

Expand All @@ -103,7 +86,3 @@ The links below will take you to each project installation page should you prefe
- [VS Code](https://code.visualstudio.com/download)
- Install [Clang](https://clang.llvm.org/get_started.html) or follow installation instructions on the [electron docs](https://www.electronjs.org/docs/development/build-instructions-linux#prerequisites)
- Development headers of `GTK 3` and `libnotify` (Follow installation instructions on the [electron docs](https://www.electronjs.org/docs/development/build-instructions-linux#prerequisites))

## Further Help

If you are still having issues setting up your computer you can find the full instructions on the [electron documentation](https://www.electronjs.org/docs/development/build-instructions-gn) for your specific OS.
2 changes: 0 additions & 2 deletions docs/quick_start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,6 @@ See [Prerequisites](prerequisites) for more information about these programs.
./winget.ps1
```

4. The "Visual Studio Installer" will open a GUI during installation. Make sure "Desktop Development with C++" is checked before continuing.

</TabItem>
<TabItem
value='mac'
Expand Down
Loading

0 comments on commit 12deaa0

Please sign in to comment.