[IMM32] Trivial tiny improvements
[reactos.git] / README.md
1 <p align=center>
2 <a href="https://reactos.org/">
3 <img alt="ReactOS" src="https://reactos.org/wiki/images/0/02/ReactOS_logo.png">
4 </a>
5 </p>
6
7 ---
8
9 <p align=center>
10 <a href="https://reactos.org/project-news/reactos-0413-released/">
11 <img alt="ReactOS 0.4.13 Release" src="https://img.shields.io/badge/release-0.4.13-0688CB.svg">
12 </a>
13 <a href="https://reactos.org/download/">
14 <img alt="Download ReactOS" src="https://img.shields.io/badge/download-latest-0688CB.svg">
15 </a>
16 <a href="https://sourceforge.net/projects/reactos/">
17 <img alt="SourceForge Download" src="https://img.shields.io/sourceforge/dm/reactos.svg?colorB=0688CB">
18 </a>
19 <a href="https://github.com/reactos/reactos/blob/master/COPYING">
20 <img alt="License" src="https://img.shields.io/badge/license-GNU_GPL_2.0-0688CB.svg">
21 </a>
22 <a href="https://reactos.org/donate/">
23 <img alt="Donate" src="https://img.shields.io/badge/%24-donate-E44E4A.svg">
24 </a>
25 <a href="https://twitter.com/reactos">
26 <img alt="Follow on Twitter" src="https://img.shields.io/twitter/follow/reactos.svg?style=social&label=Follow%20%40reactos">
27 </a>
28 </p>
29
30 ## Quick Links
31 [Website](https://reactos.org/) &bull;
32 [Official chat](https://chat.reactos.org/) &bull;
33 [Wiki](https://reactos.org/wiki/) &bull;
34 [Forum](https://reactos.org/forum/) &bull;
35 [JIRA Bug Tracker](https://jira.reactos.org/issues/) &bull;
36 [ReactOS Git mirror](https://git.reactos.org/) &bull;
37 [Testman](https://reactos.org/testman/)
38
39 ## What is ReactOS?
40
41 ReactOS™ is an Open Source effort to develop a quality operating system that is compatible with applications and drivers written for the Microsoft® Windows™ NT family of operating systems (NT4, 2000, XP, 2003, Vista, 7).
42
43 The ReactOS project, although currently focused on Windows Server 2003 compatibility, is always keeping an eye toward compatibility with Windows Vista and future Windows NT releases.
44
45 The code of ReactOS is licensed under [GNU GPL 2.0](https://github.com/reactos/reactos/blob/master/COPYING).
46
47 ### Product quality warning
48
49 **ReactOS is currently an Alpha quality operating system.** This means that ReactOS is under heavy development and you have to be ready to encounter some problems. Different things may not work well and it can corrupt the data present on your hard disk. It is HIGHLY recommended to test ReactOS on a virtual machine or on a computer with no sensitive or critical data!
50
51 ## Building
52
53 ![Build](https://github.com/reactos/reactos/workflows/Build/badge.svg) [![rosbewin.badge]][rosbewin.link] [![rosbeunix.badge]][rosbeunix.link] [![coverity.badge]][coverity.link]
54
55 To build the system it is strongly advised to use the _ReactOS Build Environment (RosBE)._
56 Up-to-date versions for Windows and for Unix/GNU-Linux are available from our download page at: ["Build Environment"](https://reactos.org/wiki/Build_Environment).
57
58 Alternatively one can use Microsoft Visual C++ (MSVC) version 2015+. Building with MSVC is covered here: ["Visual Studio or Microsoft Visual C++"](https://reactos.org/wiki/CMake#Visual_Studio_or_Microsoft_Visual_C.2B.2B).
59
60 See ["Building ReactOS"](https://reactos.org/wiki/Building_ReactOS) article for more details.
61
62 ### Binaries
63
64 To build ReactOS you must run the `configure` script in the directory you want to have your build files. Choose `configure.cmd` or `configure.sh` depending on your system. Then run `ninja <modulename>` to build a module you want or just `ninja` to build all modules.
65
66 ### Bootable images
67
68 To build a bootable CD image run `ninja bootcd` from the build directory. This will create a CD image with a filename `bootcd.iso`.
69
70 You can always download fresh binary builds of bootable images from the ["Daily builds"](https://reactos.org/getbuilds/) page.
71
72 ## Installing
73
74 By default, ReactOS currently can only be installed on a machine that has a FAT16 or FAT32 partition as the active (bootable) partition.
75 The partition on which ReactOS is to be installed (which may or may not be the bootable partition) must also be formatted as FAT16 or FAT32.
76 ReactOS Setup can format the partitions if needed.
77
78 Starting with 0.4.10, ReactOS can be installed using the BtrFS file system. But consider this as an experimental feature and thus regressions not triggered on FAT setup may be observed.
79
80 To install ReactOS from the bootable CD distribution, extract the archive contents. Then burn the CD image, boot from it, and follow the instructions.
81
82 See ["Installing ReactOS"](https://reactos.org/wiki/Installing_ReactOS) Wiki page or [INSTALL](INSTALL) for more details.
83
84 ## Testing
85
86 If you discover a bug in ReactOS search on JIRA first - it might be reported already. If not report the bug providing logs and as much information as possible.
87
88 See ["File Bugs"](https://reactos.org/wiki/File_Bugs) for a guide.
89
90 __NOTE:__ The bug tracker is _not_ for discussions. Please use our [official chat](https://chat.reactos.org/) or our [forum](https://reactos.org/forum/).
91
92 ## Contributing [![prwelcome.badge]](https://reactos.org/wiki/Commiting_Changes)
93
94 We are always looking for developers! Check [how to contribute](CONTRIBUTING.md) if you are willing to participate.
95
96 __Legal notice__: If you have seen proprietary Microsoft Windows source code (including but not limited to the leaked Windows NT 3.5, NT 4, 2000 source code and the Windows Research Kernel), your contribution won't be accepted because of potential copyright violation.
97
98 Try out cloud-based ReactOS development using Gitpod and Docker:
99
100 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/reactos/reactos)
101
102 You can also support ReactOS by [donating](https://reactos.org/donate/)! We rely on our backers to maintain our servers and accelerate development by [hiring full-time devs](https://reactos.org/contributing/#paid-jobs).
103
104 ## More information
105
106 ReactOS is a Free and Open Source operating system based on the Windows architecture,
107 providing support for existing applications and drivers, and an alternative to the current dominant consumer operating system.
108
109 It is not another wrapper built on Linux, like WINE. It does not attempt or plan to compete with WINE; in fact, the user-mode part of ReactOS is almost entirely WINE-based and our two teams have cooperated closely in the past.
110
111 ReactOS is also not "yet another OS". It does not attempt to be a third player like any other alternative OS out there. People are not meant to uninstall Linux and use ReactOS instead; ReactOS is a replacement for Windows users who want a Windows replacement that behaves just like Windows.
112
113 More information is available at: [reactos.org](https://reactos.org/).
114
115 Also see the [media/doc](/media/doc/) subdirectory for some sparse notes.
116
117 ## Who is responsible
118
119 Active devs are listed as members of [GitHub organization](https://github.com/orgs/reactos/people).
120 See also the [CREDITS](CREDITS) file for others.
121
122 ## Code mirrors
123
124 The main development is done on [GitHub](https://github.com/reactos/reactos). We have an [alternative mirror](https://git.reactos.org/?p=reactos.git) in case GitHub is down.
125
126 There is also an obsolete [SVN archive repository](https://svn.reactos.org/reactos/) that is kept for historical purposes.
127
128 [coverity.badge]: https://scan.coverity.com/projects/205/badge.svg?flat=1
129 [rosbewin.badge]: https://img.shields.io/badge/RosBE_Windows-2.2.0-0688CB.svg
130 [rosbeunix.badge]: https://img.shields.io/badge/RosBE_Unix-2.2-0688CB.svg
131 [prwelcome.badge]: https://img.shields.io/badge/PR-welcome-0688CB.svg
132
133 [coverity.link]: https://scan.coverity.com/projects/205
134 [rosbewin.link]: https://sourceforge.net/projects/reactos/files/RosBE-Windows/i386/2.2.0/
135 [rosbeunix.link]: https://sourceforge.net/projects/reactos/files/RosBE-Unix/2.2/