From 21ed118f348878b9f02e8230795e294c076c9263 Mon Sep 17 00:00:00 2001 From: Mike Schinkel Date: Sun, 6 Jun 2021 22:18:38 -0400 Subject: [PATCH 1/2] Add notes to make it obvious how to get Sqlite support After spending over an hour trying to figure out why `sqlite` was not available as a --db-type with the `buffalo` command I finally realized that the section that said "Custom installation with SQLite3 Support" meant "to get Sqlite support you MUST do a custom installation" instead of what I initially thought it meant which was "when doing a custom installation this is the way to do it with Sqlite support vs. the next section which shows how to do it without Sqlite support." This pull request is my attempt to help the next person who comes along and is as confused by the docs as I was. --- templates/en/docs/getting-started/installation.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/templates/en/docs/getting-started/installation.md b/templates/en/docs/getting-started/installation.md index c5496abd0..bd17f0688 100644 --- a/templates/en/docs/getting-started/installation.md +++ b/templates/en/docs/getting-started/installation.md @@ -38,7 +38,7 @@ Again, if you don't need a database, you won't need these. ## Installation from a release archive - 64 bits <%= note() { %> -The release packages contain Buffalo without SQLite support. +The release packages contain Buffalo without SQLite support. For SQLite support use a [custom installation](#custom-installation-with-sqlite3-support). <% } %> Since `v0.10.3`, pre-compiled archives are provided with each release. If you don't need the latest cutting-edge version, you'll probably prefer to install this version. @@ -50,6 +50,7 @@ $ wget https://github.com/gobuffalo/buffalo/releases/download/v<%= version %>/bu $ tar -xvzf buffalo_<%= version %>_Linux_x86_64.tar.gz $ sudo mv buffalo /usr/local/bin/buffalo ``` +If you need Sqlite support use a [custom installation](#custom-installation-with-sqlite3-support). ### MacOS @@ -60,24 +61,26 @@ $ sudo mv buffalo /usr/local/bin/buffalo # or if you have ~/bin folder setup in the environment PATH variable $ mv buffalo ~/bin/buffalo ``` +If you need Sqlite support use a [custom installation](#custom-installation-with-sqlite3-support). ## Scoop (Windows) -Buffalo can be installed using the [Scoop](http://scoop.sh/) package manager: +Buffalo can be installed _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ using the [Scoop](http://scoop.sh/) package manager: ```powershell PS C:\> scoop install buffalo ``` ## Chocolatey (Windows) -Buffalo can be installed using the [Chocolatey](https://chocolatey.org/packages/buffalo) package manager. Versions on Chocolatey are published with a potential delay and must go through moderation before they are available: +Buffalo can be installed _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ using the [Chocolatey](https://chocolatey.org/packages/buffalo) package manager. Versions on Chocolatey are published with a potential delay and must go through moderation before they are available: ```powershell PS C:\> choco install buffalo ``` +If you need Sqlite support use a [custom installation](#custom-installation-with-sqlite3-support). ## Homebrew (macOS) -On macOS, you can also install Buffalo with [Homebrew](https://brew.sh/). After you have Homebrew [installed](https://docs.brew.sh/Installation), you can easily install Buffalo: +On macOS, you can also install Buffalo _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ using [Homebrew](https://brew.sh/). After you have Homebrew [installed](https://docs.brew.sh/Installation), you can easily install Buffalo: ```bash brew install gobuffalo/tap/buffalo @@ -87,7 +90,7 @@ brew install gobuffalo/tap/buffalo [GoFish](https://gofi.sh/index.html) is a cross-platform systems package manager, that works across Windows, MacOSX and Linux. -After you have GoFish [installed](https://gofi.sh/index.html#install), you can very simply install Buffalo: +After you have GoFish [installed](https://gofi.sh/index.html#install), you can install Buffalo _(w/o [_Sqlite support_](#custom-installation-with-sqlite3-support))_ very simply with: ```bash $ gofish install buffalo @@ -95,6 +98,7 @@ $ gofish install buffalo 🐠 buffalo <%= version %>: installed in 3.223672926s ``` + ## Custom installation **with** SQLite3 Support **SQLite 3** requires a GCC, or equivalent C compiler for [mattn/go-sqlite3](https://github.com/mattn/go-sqlite3) to compile. You **must** have a GCC installed **first** before installing Buffalo. From 07b4326c089fa5b7a54975408c284e05c99a096b Mon Sep 17 00:00:00 2001 From: Mike Schinkel Date: Sun, 6 Jun 2021 22:21:22 -0400 Subject: [PATCH 2/2] Removed redundant Sqlite notice for Chocolatey --- templates/en/docs/getting-started/installation.md | 1 - 1 file changed, 1 deletion(-) diff --git a/templates/en/docs/getting-started/installation.md b/templates/en/docs/getting-started/installation.md index bd17f0688..c676daffb 100644 --- a/templates/en/docs/getting-started/installation.md +++ b/templates/en/docs/getting-started/installation.md @@ -76,7 +76,6 @@ Buffalo can be installed _(w/o [_Sqlite support_](#custom-installation-with-sqli ```powershell PS C:\> choco install buffalo ``` -If you need Sqlite support use a [custom installation](#custom-installation-with-sqlite3-support). ## Homebrew (macOS)