xref: /reactos/README.md (revision 7abc22c3)
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
41ReactOS™ 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, Seven).
42
43The 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
45The code of ReactOS is licensed under [GNU GPL 2.0](https://github.com/reactos/reactos/blob/master/COPYING).
46
47***ReactOS is currently an Alpha quality operating system. This means that ReactOS is under heavy development, things may not work well and it can corrupt the data present on your hard disk. It is recommended to test ReactOS on a virtual machine or on a computer with no sensitive or critical data!***
48
49## Building
50
51![Build](https://github.com/reactos/reactos/workflows/Build/badge.svg) [![rosbewin.badge]][rosbewin.link] [![rosbeunix.badge]][rosbeunix.link] [![coverity.badge]][coverity.link]
52
53To build the system it is strongly advised to use the _ReactOS Build Environment (RosBE)._
54Up-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).
55
56Alternatively 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).
57
58### Binaries
59
60To 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.
61
62### Bootable images
63
64To build a bootable CD image run `ninja bootcd` from the
65build directory. This will create a CD image with a filename `bootcd.iso`.
66
67See ["Building ReactOS"](https://reactos.org/wiki/Building_ReactOS) for more details.
68
69You can always download fresh binary builds of bootable images from the ["Daily builds"](https://reactos.org/getbuilds/) page.
70
71## Installing
72
73By default, ReactOS currently can only be installed on a machine that has a FAT16 or FAT32 partition as the active (bootable) partition.
74The 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.
75ReactOS Setup can format the partitions if needed.
76
77Starting 0.4.10, ReactOS can be installed using the BtrFS file system. But
78consider this as an experimental feature and thus regressions not triggered on
79FAT setup may be observed.
80
81To install ReactOS from the bootable CD distribution, extract the archive contents. Then burn the CD image, boot from it, and follow the instructions.
82
83See ["Installing ReactOS"](https://reactos.org/wiki/Installing_ReactOS) Wiki page or [INSTALL](INSTALL) for more details.
84
85## Testing
86
87If 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.
88
89See ["File Bugs"](https://reactos.org/wiki/File_Bugs) for a guide.
90
91__NOTE:__ The bug tracker is _not_ for discussions. Please use our [official chat](https://chat.reactos.org/) or our [forum](https://reactos.org/forum/).
92
93## Contributing  [![prwelcome.badge]](https://reactos.org/wiki/Commiting_Changes)
94
95We are always looking for developers! Check [how to contribute](CONTRIBUTING.md) if you are willing to participate.
96
97Try out cloud-based ReactOS development using Gitpod and Docker:
98
99[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/reactos/reactos)
100
101You 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).
102
103## More information
104
105ReactOS is a Free and Open Source operating system based on the Windows architecture,
106providing support for existing applications and drivers, and an alternative to the current dominant consumer operating system.
107
108It 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.
109
110ReactOS 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.
111
112More information is available at: [reactos.org](https://reactos.org/).
113
114Also see the [media/doc](/media/doc/) subdirectory for some sparse notes.
115
116## Who is responsible
117
118Active devs are listed as members of [GitHub organization](https://github.com/orgs/reactos/people).
119See also the [CREDITS](CREDITS) file for others.
120
121## Code mirrors
122
123The 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.
124
125There is also an obsolete [SVN archive repository](https://svn.reactos.org/reactos/) that is kept for historical purposes.
126
127[coverity.badge]:   https://scan.coverity.com/projects/205/badge.svg?flat=1
128[rosbewin.badge]:   https://img.shields.io/badge/RosBE_Windows-2.2.0-0688CB.svg
129[rosbeunix.badge]:  https://img.shields.io/badge/RosBE_Unix-2.2-0688CB.svg
130[prwelcome.badge]:  https://img.shields.io/badge/PR-welcome-0688CB.svg
131
132[coverity.link]:    https://scan.coverity.com/projects/205
133[rosbewin.link]:    https://sourceforge.net/projects/reactos/files/RosBE-Windows/i386/2.2.0/
134[rosbeunix.link]:   https://sourceforge.net/projects/reactos/files/RosBE-Unix/2.2/
135