awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

(docs): correct how to install gcc on Windows (#2013)

Browse Source 
* docs: Correct how to install gcc on Windows

PATH needs to be manually set on Windows. Previously, it was explicitly
mentioned that it was unnecessary. More recent experience is that it's necessary.

* regenerate texi

Co-authored-by: Jethro Kuan <jethrokuan95@gmail.com>
This commit is contained in:
Noboru Ota
2021-12-23 10:22:02 +01:00
committed by GitHub
parent c90b2d68df
commit d0f17c6477
2 changed files with 31 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/org-roam.org
View File

@ -288,29 +288,25 @@ in your Emacs environment as a prerequisite for Org-roam when you install it.
~emacsql-sqlite~ requires a C compiler (e.g. ~gcc~ or ~clang~) to be present in
your computer. How to install a C compiler depends on the OS that you use.
- For Windows:
**** C Compiler for Windows
There are various ways to install one, depending on how you have installed
Emacs. If you use Emacs within a Cygwin or MinGW environment, then you should
install a compiler using their respective package manager.
One of the easiest ways to install a C compiler in Windows is to use [[https://www.msys2.org/][MSYS2]] as at the time of this writing:
If you have installed your Emacs from the [[https://www.gnu.org/software/emacs/][GNU Emacs website]], then the easiest way
is to use [[https://www.msys2.org/][MSYS2]] as at the time of this writing:
1. Use the installer in the official website and install MSYS2
2. Run MSYS2
3. In the command-line tool, type the following and answer "Y" to proceed:
1. Download and use the installer in the official MSYS2 website
2. Run MSYS2 and in its terminal, type the following and answer "Y" to
proceed -- this will install ~gcc~ in your PC:
#+BEGIN_SRC bash
pacman -S gcc
#+END_SRC
Note that you do not need to manually set the PATH for MSYS2; the
installer automatically takes care of it for you.
4. On Windows, add ~C:\msys64\usr\bin~ (command =where gcc= in MSYS2 terminal
can tell you the correct path) to ~PATH~ in your environmental variables
4. Open Emacs and call ~M-x org-roam-db-autosync-mode~
5. Launch Emacs and call ~M-x org-roam-db-autosync-mode~ (launch Emacs after
defining the path, so that Emacs can recognize it)
This will automatically start compiling ~emacsql-sqlite~; you should see a
This will automatically start compiling ~emacsql-sqlite~; you should see a
message in minibuffer. It may take a while until compilation completes. Once
complete, you should see a new file ~emacsql-sqlite.exe~ created in a subfolder
named ~sqlite~ under ~emacsql-sqlite~ installation folder. It's typically in

41
doc/org-roam.texi
View File

@ -100,6 +100,10 @@ Installation Troubleshooting
* C Compiler::
C Compiler
* C Compiler for Windows::
Getting Started
* The Org-roam Node::
@ -535,42 +539,39 @@ in your Emacs environment as a prerequisite for Org-roam when you install it.
@code{emacsql-sqlite} requires a C compiler (e.g. @code{gcc} or @code{clang}) to be present in
your computer. How to install a C compiler depends on the OS that you use.
@itemize
@item
For Windows:
@end itemize
@menu
* C Compiler for Windows::
@end menu
There are various ways to install one, depending on how you have installed
Emacs. If you use Emacs within a Cygwin or MinGW environment, then you should
install a compiler using their respective package manager.
@node C Compiler for Windows
@unnumberedsubsubsec C Compiler for Windows
If you have installed your Emacs from the @uref{https://www.gnu.org/software/emacs/, GNU Emacs website}, then the easiest way
is to use @uref{https://www.msys2.org/, MSYS2} as at the time of this writing:
One of the easiest ways to install a C compiler in Windows is to use @uref{https://www.msys2.org/, MSYS2} as at the time of this writing:
@itemize
@item
Use the installer in the official website and install MSYS2
Download and use the installer in the official MSYS2 website
@item
Run MSYS2
@item
In the command-line tool, type the following and answer ``Y'' to proceed:
Run MSYS2 and in its terminal, type the following and answer ``Y'' to
proceed -- this will install @code{gcc} in your PC:
@example
pacman -S gcc
@end example
Note that you do not need to manually set the PATH for MSYS2; the
@end itemize
installer automatically takes care of it for you.
@itemize
@item
Open Emacs and call @code{M-x org-roam-db-autosync-mode}
On Windows, add @code{C:\msys64\usr\bin} (command @samp{where gcc} in MSYS2 terminal
can tell you the correct path) to @code{PATH} in your environmental variables
@item
Launch Emacs and call @code{M-x org-roam-db-autosync-mode} (launch Emacs after
defining the path, so that Emacs can recognize it)
@end itemize
This will automatically start compiling @code{emacsql-sqlite}; you should see a
@end itemize
message in minibuffer. It may take a while until compilation completes. Once
complete, you should see a new file @code{emacsql-sqlite.exe} created in a subfolder
named @code{sqlite} under @code{emacsql-sqlite} installation folder. It's typically in