Skip to content

Commit faa8b4c

Browse files
authored
Merge pull request #121 from robertmabbs/master
Update readme
2 parents 30930d9 + b502ab5 commit faa8b4c

File tree

1 file changed

+37
-23
lines changed

1 file changed

+37
-23
lines changed

README.md

Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,42 @@ The goal of this project is to generate an installer that when run installs all
88
of the most common components for a Rails development environment with no
99
required prerequisites on a Windows system.
1010

11+
## How to Install
12+
Currently RailsInstaller does not include everything to get rails to work on Windows. Slowly each part will get added back in, but for
13+
now you will need to follow instructions below to get rails installed.
14+
15+
1. Download and install
16+
[Git](https://github.com/git-for-windows/git/releases/download/v2.38.0.windows.1/Git-2.38.0-64-bit.exe).
17+
18+
2. Download and install
19+
[Nodejs](https://nodejs.org/dist/v16.17.1/node-v16.17.1-x64.msi).
20+
21+
3. Download and install
22+
[Yarn](https://classic.yarnpkg.com/latest.msi).
23+
24+
4. Download and install
25+
[RailsInstaller](https://github.com/railsinstaller/railsinstaller-windows/releases/download/v4.0.0-alpha/railsinstaller-4.0.0.exe).
26+
27+
# RailsInstaller Components
28+
29+
The next few sections detail the core components that make up RailsInstaller.
30+
31+
### Ruby 3.1.2 on Windows
32+
33+
RubyInstaller is a self contained package installer which installs Ruby and RubyGems on a windows system, head over to [http://rubyinstaller.org/](http://rubyinstaller.org/) for more information.
34+
35+
### Development Kit (DevKit)
36+
37+
A MSYS/MinGW based toolkit that enables RailsInstaller to build native C/C++ packages, both for Ruby and gems. DevKit is built and maintained by the wonderful folks over at the RubyInstaller project.
38+
39+
### Packaging/Installer
40+
41+
We are using [Inno Setup](http://www.jrsoftware.org/isinfo.php "Inno Setup"), a free installer for Windows programs.
42+
1143
## How to Contribute
1244

45+
The information below is out of date and will be updated soon.
46+
1347
RailsInstaller project code repository is located on GitHub and is bootstrapped,
1448
built and packaged via rake tasks.
1549

@@ -65,8 +99,9 @@ built and packaged via rake tasks.
6599
66100
1. Use Inno Setup to package the installer into an executable (.exe) for testing/distribution.
67101
68-
```bat
69-
SET PATH=C:\Program Files\Inno Setup 5;%PATH%
102+
Add iscc.exe in your PATH
103+
```
104+
C:\Program Files (x86)\Inno Setup 6\ISCC.exe
70105
rake package
71106
```
72107
@@ -82,24 +117,3 @@ built and packaged via rake tasks.
82117
```
83118
84119
1. Now issue a [pull request](https://help.github.com/articles/using-pull-requests) on GitHub.
85-
86-
# RailsInstaller Components
87-
88-
The next few sections detail the core components that make up RailsInstaller.
89-
90-
### Ruby 2.2.3 on Windows
91-
92-
RubyInstaller is a self contained package installer which installs Ruby and RubyGems on a windows system, head over to [http://rubyinstaller.org/](http://rubyinstaller.org/) for more information.
93-
94-
### Development Kit (DevKit)
95-
96-
A MSYS/MinGW based toolkit that enables RailsInstaller to build native C/C++ packages, both for Ruby and gems. DevKit is built and maintained by the wonderful folks over at the RubyInstaller project.
97-
98-
### Git
99-
100-
The git version that is bundled into RailsInstaller is
101-
[msysgit](http://msysgit.github.io/).
102-
103-
### Packaging/Installer
104-
105-
We are using [Inno Setup](http://www.jrsoftware.org/isinfo.php "Inno Setup"), a free installer for Windows programs.

0 commit comments

Comments
 (0)