Skip to content

Commit f9a61fa

Browse files
julliardIsaacMarovitz
authored andcommitted
readme: Convert to Markdown
1 parent db74880 commit f9a61fa

File tree

1 file changed

+49
-52
lines changed

1 file changed

+49
-52
lines changed

README README.md

+49-52
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
1. INTRODUCTION
1+
## INTRODUCTION
22

33
Wine is a program which allows running Microsoft Windows programs
44
(including DOS, Windows 3.x, Win32, and Win64 executables) on Unix.
@@ -11,163 +11,160 @@ Wine is free software, released under the GNU LGPL; see the file
1111
LICENSE for the details.
1212

1313

14-
2. QUICK START
14+
## QUICK START
1515

1616
From the top-level directory of the Wine source (which contains this file),
1717
run:
1818

19+
```
1920
./configure
2021
make
22+
```
2123

2224
Then either install Wine:
2325

26+
```
2427
make install
28+
```
2529

2630
Or run Wine directly from the build directory:
2731

32+
```
2833
./wine notepad
34+
```
2935

30-
Run programs as "wine program". For more information and problem
36+
Run programs as `wine program`. For more information and problem
3137
resolution, read the rest of this file, the Wine man page, and
3238
especially the wealth of information found at https://www.winehq.org.
3339

3440

35-
3. REQUIREMENTS
41+
## REQUIREMENTS
3642

3743
To compile and run Wine, you must have one of the following:
3844

39-
Linux version 2.0.36 or later
40-
FreeBSD 8.0 or later
41-
Solaris x86 9 or later
42-
NetBSD-current
43-
Mac OS X 10.8 or later
45+
- Linux version 2.6.22 or later
46+
- FreeBSD 12.4 or later
47+
- Solaris x86 9 or later
48+
- NetBSD-current
49+
- Mac OS X 10.8 or later
4450

4551
As Wine requires kernel-level thread support to run, only the operating
4652
systems mentioned above are supported. Other operating systems which
4753
support kernel threads may be supported in the future.
4854

49-
FreeBSD info:
50-
Wine will generally not work properly on versions before FreeBSD 8.0.
55+
**FreeBSD info**:
5156
See https://wiki.freebsd.org/Wine for more information.
5257

53-
Solaris info:
58+
**Solaris info**:
5459
You will most likely need to build Wine with the GNU toolchain
5560
(gcc, gas, etc.). Warning : installing gas does *not* ensure that it
5661
will be used by gcc. Recompiling gcc after installing gas or
5762
symlinking cc, as and ld to the gnu tools is said to be necessary.
5863

59-
NetBSD info:
64+
**NetBSD info**:
6065
Make sure you have the USER_LDT, SYSVSHM, SYSVSEM, and SYSVMSG options
6166
turned on in your kernel.
6267

63-
Mac OS X info:
68+
**Mac OS X info**:
6469
You need Xcode/Xcode Command Line Tools or Apple cctools. The
6570
minimum requirements for compiling Wine are clang 3.8 with the
6671
MacOSX10.10.sdk and mingw-w64 v8. The MacOSX10.14.sdk and later can
6772
only build wine64.
6873

69-
70-
Supported file systems:
74+
**Supported file systems**:
7175
Wine should run on most file systems. A few compatibility problems
7276
have also been reported using files accessed through Samba. Also,
7377
NTFS does not provide all the file system features needed by some
7478
applications. Using a native Unix file system is recommended.
7579

76-
Basic requirements:
80+
**Basic requirements**:
7781
You need to have the X11 development include files installed
7882
(called xorg-dev in Debian and libX11-devel in Red Hat).
79-
80-
Of course you also need "make" (most likely GNU make).
81-
83+
Of course you also need make (most likely GNU make).
8284
You also need flex version 2.5.33 or later and bison.
8385

84-
Optional support libraries:
86+
**Optional support libraries**:
8587
Configure will display notices when optional libraries are not found
8688
on your system. See https://wiki.winehq.org/Recommended_Packages for
8789
hints about the packages you should install. On 64-bit platforms,
8890
you have to make sure to install the 32-bit versions of these
8991
libraries.
9092

9193

92-
4. COMPILATION
94+
## COMPILATION
9395

9496
To build Wine, do:
9597

98+
```
9699
./configure
97100
make
101+
```
98102

99103
This will build the program "wine" and numerous support libraries/binaries.
100104
The program "wine" will load and run Windows executables.
101105
The library "libwine" ("Winelib") can be used to compile and link
102106
Windows source code under Unix.
103107

104-
To see compile configuration options, do ./configure --help.
108+
To see compile configuration options, do `./configure --help`.
105109

106110
For more information, see https://wiki.winehq.org/Building_Wine
107111

108112

109-
5. SETUP
113+
## SETUP
110114

111-
Once Wine has been built correctly, you can do "make install"; this
115+
Once Wine has been built correctly, you can do `make install`; this
112116
will install the wine executable and libraries, the Wine man page, and
113117
other needed files.
114118

115119
Don't forget to uninstall any conflicting previous Wine installation
116-
first. Try either "dpkg -r wine" or "rpm -e wine" or "make uninstall"
120+
first. Try either `dpkg -r wine` or `rpm -e wine` or `make uninstall`
117121
before installing.
118122

119-
Once installed, you can run the "winecfg" configuration tool. See the
123+
Once installed, you can run the `winecfg` configuration tool. See the
120124
Support area at https://www.winehq.org/ for configuration hints.
121125

122126

123-
6. RUNNING PROGRAMS
127+
## RUNNING PROGRAMS
124128

125129
When invoking Wine, you may specify the entire path to the executable,
126130
or a filename only.
127131

128-
For example: to run Notepad:
132+
For example, to run Notepad:
129133

130-
wine notepad (using the search Path as specified in
131-
wine notepad.exe the registry to locate the file)
134+
```
135+
wine notepad (using the search Path as specified in
136+
wine notepad.exe the registry to locate the file)
132137
133-
wine c:\\windows\\notepad.exe (using DOS filename syntax)
138+
wine c:\\windows\\notepad.exe (using DOS filename syntax)
134139
135-
wine ~/.wine/drive_c/windows/notepad.exe (using Unix filename syntax)
140+
wine ~/.wine/drive_c/windows/notepad.exe (using Unix filename syntax)
136141
137-
wine notepad.exe readme.txt (calling program with parameters)
142+
wine notepad.exe readme.txt (calling program with parameters)
143+
```
138144

139145
Wine is not perfect, so some programs may crash. If that happens you
140146
will get a crash log that you should attach to your report when filing
141147
a bug.
142148

143149

144-
7. GETTING MORE INFORMATION
150+
## GETTING MORE INFORMATION
145151

146-
WWW: A great deal of information about Wine is available from WineHQ at
152+
- **WWW**: A great deal of information about Wine is available from WineHQ at
147153
https://www.winehq.org/ : various Wine Guides, application database,
148154
bug tracking. This is probably the best starting point.
149155

150-
FAQ: The Wine FAQ is located at https://www.winehq.org/FAQ
156+
- **FAQ**: The Wine FAQ is located at https://www.winehq.org/FAQ
157+
158+
- **Wiki**: The Wine Wiki is located at https://wiki.winehq.org
151159

152-
Wiki: The Wine Wiki is located at https://wiki.winehq.org
160+
- **Gitlab**: Wine development is hosted at https://gitlab.winehq.org
153161

154-
Mailing lists:
162+
- **Mailing lists**:
155163
There are several mailing lists for Wine users and developers;
156164
see https://www.winehq.org/forums for more information.
157165

158-
Bugs: Report bugs to Wine Bugzilla at https://bugs.winehq.org
166+
- **Bugs**: Report bugs to Wine Bugzilla at https://bugs.winehq.org
159167
Please search the bugzilla database to check whether your
160168
problem is already known or fixed before posting a bug report.
161169

162-
IRC: Online help is available at channel #WineHQ on irc.libera.chat.
163-
164-
Git: The current Wine development tree is available through Git.
165-
Go to https://www.winehq.org/git for more information.
166-
167-
If you add something, or fix a bug, please send a patch (preferably
168-
using git-format-patch) to the wine-devel@winehq.org list for
169-
inclusion in the next release.
170-
171-
--
172-
Alexandre Julliard
173-
julliard@winehq.org
170+
- **IRC**: Online help is available at channel `#WineHQ` on irc.libera.chat.

0 commit comments

Comments
 (0)