diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/installation_instructions_for_windows.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/docs/installation_instructions_for_windows.md b/docs/installation_instructions_for_windows.md index b8c18c9d..c19321b4 100644 --- a/docs/installation_instructions_for_windows.md +++ b/docs/installation_instructions_for_windows.md | |||
@@ -21,7 +21,7 @@ one installed, see below.) | |||
21 | 21 | ||
22 | <b>Important:</b> To compile many Lua packages, you will also need a C compiler. | 22 | <b>Important:</b> To compile many Lua packages, you will also need a C compiler. |
23 | The installer batch file included in the all-in-one package attempts to detect | 23 | The installer batch file included in the all-in-one package attempts to detect |
24 | if you have Microsoft Visual Studio or [Mingw](https://mingw.org) (Minimalistic GNU for Windows, which includes GCC). | 24 | if you have Microsoft Visual Studio or [Mingw](https://mingw-w64.org) (Minimalistic GNU for Windows, which includes GCC). |
25 | 25 | ||
26 | The installer script, <tt>INSTALL.BAT</tt>, provides a number of options for | 26 | The installer script, <tt>INSTALL.BAT</tt>, provides a number of options for |
27 | customizing your installation. Run <tt>INSTALL /?</tt> for details. | 27 | customizing your installation. Run <tt>INSTALL /?</tt> for details. |
@@ -33,7 +33,7 @@ MSVC compiler, `cl`, are set. | |||
33 | 33 | ||
34 | * If you using <a href="https://www.cygwin.com/">Cygwin</a> then go through [installation instructions for Unix](installation_instructions_for_unix.md). | 34 | * If you using <a href="https://www.cygwin.com/">Cygwin</a> then go through [installation instructions for Unix](installation_instructions_for_unix.md). |
35 | 35 | ||
36 | # The default settings | 36 | # The default settings |
37 | 37 | ||
38 | The default settings are suitable for installing LuaRocks globally | 38 | The default settings are suitable for installing LuaRocks globally |
39 | in your system while allowing both system-wide and per-user sets of rocks. | 39 | in your system while allowing both system-wide and per-user sets of rocks. |
@@ -41,7 +41,7 @@ Non-priviledged accounts will be able to install their own rocks in their | |||
41 | %APPDATA% directory, and administrator accounts can install rocks that | 41 | %APPDATA% directory, and administrator accounts can install rocks that |
42 | will be available for everyone. | 42 | will be available for everyone. |
43 | 43 | ||
44 | # Making a system-wide repository | 44 | # Making a system-wide repository |
45 | 45 | ||
46 | All paths described above can be overridden with flags in the INSTALL.BAT script, | 46 | All paths described above can be overridden with flags in the INSTALL.BAT script, |
47 | or entries in the configuration file. | 47 | or entries in the configuration file. |
@@ -88,7 +88,7 @@ Compiler configuration: | |||
88 | Other options: | 88 | Other options: |
89 | 89 | ||
90 | {| cellpadding=5px | 90 | {| cellpadding=5px |
91 | | /FORCECONFIG || Use a single config location. Do not use the LUAROCKS_CONFIG variable or the user's home directory. Useful to avoid conflicts when LuaRocks is embedded | 91 | | /FORCECONFIG || Use a single config location. Do not use the LUAROCKS_CONFIG variable or the user's home directory. Useful to avoid conflicts when LuaRocks is embedded |
92 | |------------------------------------------------------------------------- | 92 | |------------------------------------------------------------------------- |
93 | | /F || Force. Remove installation directory if it already exists. | 93 | | /F || Force. Remove installation directory if it already exists. |
94 | |------------------------------------------------------------------------- | 94 | |------------------------------------------------------------------------- |
@@ -101,7 +101,7 @@ Other options: | |||
101 | 101 | ||
102 | After installation, a default config file called config.lua will be installed at the directory defined by /CONFIG. For further configuration of LuaRocks paths, see the [Config file format](config_file_format.md). For more information on the structure of rocks trees see [rocks repositories](rocks_repositories.md). | 102 | After installation, a default config file called config.lua will be installed at the directory defined by /CONFIG. For further configuration of LuaRocks paths, see the [Config file format](config_file_format.md). For more information on the structure of rocks trees see [rocks repositories](rocks_repositories.md). |
103 | 103 | ||
104 | # Making a self-contained installation | 104 | # Making a self-contained installation |
105 | 105 | ||
106 | Another option is to install LuaRocks in a self-contained manner. This | 106 | Another option is to install LuaRocks in a self-contained manner. This |
107 | is an interesting alternative when shipping an application which uses | 107 | is an interesting alternative when shipping an application which uses |
@@ -109,7 +109,7 @@ third-party modules. Bundling them as rocks reduces maintenance overhead | |||
109 | and allows the user to perform updates. | 109 | and allows the user to perform updates. |
110 | 110 | ||
111 | In this scenario, it is not desired to have the user's (or the system's) | 111 | In this scenario, it is not desired to have the user's (or the system's) |
112 | configuration affect the self-contained LuaRocks install, in case the | 112 | configuration affect the self-contained LuaRocks install, in case the |
113 | user or the system also have different LuaRocks installations. For this | 113 | user or the system also have different LuaRocks installations. For this |
114 | reason, the INSTALL.BAT script allows to hardcode the location of a | 114 | reason, the INSTALL.BAT script allows to hardcode the location of a |
115 | configuration file. For example, the compilation process of a package | 115 | configuration file. For example, the compilation process of a package |
@@ -135,15 +135,15 @@ repositories = { | |||
135 | } | 135 | } |
136 | ``` | 136 | ``` |
137 | 137 | ||
138 | # Picking the Lua interpreter | 138 | # Picking the Lua interpreter |
139 | 139 | ||
140 | LuaRocks can use its own Lua interpreter provided by the Lua for WIndows project, | 140 | LuaRocks can use its own Lua interpreter provided by the Lua for WIndows project, |
141 | and will do so by default if it fails to find your Lua installation | 141 | and will do so by default if it fails to find your Lua installation |
142 | automatically. If you want to use your own interpreter, which is not on the system path, | 142 | automatically. If you want to use your own interpreter, which is not on the system path, |
143 | you can pass its path using the /LUA variable (or /BIN, /LIB and /INC explicitly, if | 143 | you can pass its path using the /LUA variable (or /BIN, /LIB and /INC explicitly, if |
144 | you have a custom directory structure). | 144 | you have a custom directory structure). |
145 | 145 | ||
146 | When looking for an interpreter, it will also try to figure out the name of | 146 | When looking for an interpreter, it will also try to figure out the name of |
147 | the Lua binary (lua.exe, lua5.1.exe). This is set in the `lua_interpreter` | 147 | the Lua binary (lua.exe, lua5.1.exe). This is set in the `lua_interpreter` |
148 | variable in the configuration file. If you want to use an alternative name to the | 148 | variable in the configuration file. If you want to use an alternative name to the |
149 | interpreter, you can set that variable in your configuration file directly. | 149 | interpreter, you can set that variable in your configuration file directly. |
@@ -152,7 +152,7 @@ An important element is the runtime libraries used by the interpreter, as LuaRoc | |||
152 | compile additional rocks installed with the same runtime as the interpreter. To do this | 152 | compile additional rocks installed with the same runtime as the interpreter. To do this |
153 | LuaRocks will analyse the executable found. | 153 | LuaRocks will analyse the executable found. |
154 | 154 | ||
155 | # Next steps | 155 | # Next steps |
156 | 156 | ||
157 | Once LuaRocks is installed, learn more about [using LuaRocks](using_luarocks.md). | 157 | Once LuaRocks is installed, learn more about [using LuaRocks](using_luarocks.md). |
158 | 158 | ||