Skip to content

Commit

Permalink
Added homebrew icon and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
The-EDev authored and gittiver committed Oct 31, 2024
1 parent c10c20c commit 05a42c3
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/assets/pkg_logos/homebrew.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/getting_started/setup/macos.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
Here's how you can install Crow on your Mac.
## Getting Crow

### From Homebrew
1. Download and install [Homebrew](https://brew.sh).
2. Run `brew install crow` in your terminal.

### From a [release](https://github.com/CrowCpp/Crow/releases)
#### Archive
Crow provides an archive containing the framework and CMake files, You will only need the `include` folder inside that archive.
Expand All @@ -22,6 +27,10 @@ This will generate a `crow_all.h` file which you can use in the following steps


## Setting up your Crow project
!!! note

You can skip steps 1 and 2 if you've installed Crow via Homebrew

### Using XCode
1. Download and install [Homebrew](https://brew.sh).
2. Run `brew install asio` in your terminal.
Expand Down Expand Up @@ -51,6 +60,10 @@ This will generate a `crow_all.h` file which you can use in the following steps

This tutorial can be used for Crow projects built with CMake as well

!!! note

You can skip steps 1 and 2 if you've installed Crow via Homebrew

1. Download and install [Homebrew](https://brew.sh).
2. Run `brew install cmake asio` in your terminal.
3. Get Crow's source code (the entire source code).
Expand Down
10 changes: 9 additions & 1 deletion docs/overrides/home.html
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,15 @@ <h3 style="text-align:center;">Crow is everywhere, you just need to grab it!<h3>
<a href="https://vcpkg.io">
<img class="dcard__image" src="assets/pkg_logos/vcpkg.png">
<p class="dcard__title">VCPKG</p>
<p class="dcard__description">for Windows systems</p>
<p class="dcard__description">for Windows based systems</p>
</a>
</div>

<div class="dcard">
<a href="https://formulae.brew.sh/formula/crow">
<img class="dcard__image" src="assets/pkg_logos/homebrew.svg">
<p class="dcard__title">Homebrew</p>
<p class="dcard__description">for MacOS based systems</p>
</a>
</div>

Expand Down

0 comments on commit 05a42c3

Please sign in to comment.