e191d11aa23a7247183d1cdf8876f34181655470
[reactos.git] / README.md
1 # ReactOS Project [![appveyor.badge]][appveyor.link] [![travis.badge]][travis.link] [![flattr.badge]][flattr.link] [![tweetme.badge]][tweetme.link]
2
3 <p align=center>
4 <img src="https://reactos.org/wiki/images/0/02/ReactOS_logo.png">
5 </p>
6
7 [![license.badge]][license.link] [![release.badge]][release.link] [![sfstats.badge]][sfstats.link] [![coverity.badge]][coverity.link]
8
9 ## Quick Links
10
11 - [Website](https://reactos.org)
12 - [Wiki](https://reactos.org/wiki)
13 - [Forum](https://reactos.org/forum)
14 - [JIRA Bug Tracker](https://jira.reactos.org/issues)
15 - [ReactOS Git mirror](https://git.reactos.org)
16 - [Testman](https://reactos.org/testman/)
17
18 ## What is ReactOS?
19
20 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, Seven).
21
22 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.
23
24 The code of ReactOS is licensed under [GNU GPL 2.0+](https://spdx.org/licenses/GPL-2.0+.html).
25
26 ## Building [![rosbewin.badge]][rosbewin.link] [![rosbeunix.badge]][rosbeunix.link]
27
28 To build the system it is strongly advised to use the _ReactOS Build Environment (RosBE)._
29 Up-to-date versions for Windows and for Unix/GNU-Linux are available from our download page at: http://www.reactos.org/wiki/Build_Environment.
30
31 Alternatively one can use Microsoft Visual C++ (MSVC) version 2010+. Building with MSVC is covered here: https://www.reactos.org/wiki/Building_with_MSVC.
32
33 ### Binaries
34
35 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.
36
37 ### Bootable images
38
39 To build a bootable CD image run `ninja bootcd` from the
40 build directory. This will create a CD image with a filename `bootcd.iso`.
41
42 See ["Building ReactOS"](http://www.reactos.org/wiki/Building_ReactOS) for more details.
43
44 ## Installing
45
46 ReactOS currently can only be installed on a machine that has a FAT16 or FAT32 partition as the active (bootable) partition.
47 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.
48 ReactOS Setup can format the partitions if needed.
49
50 To install ReactOS from the bootable CD distribution, extract the archive contents. Then burn the CD image, boot from it, and follow the instructions.
51
52 See ["Installing ReactOS"](https://www.reactos.org/wiki/Installing_ReactOS) Wiki page or [INSTALL](INSTALL) for more details.
53
54 ## Testing
55
56 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 many information as possible.
57
58 See ["File Bugs"](https://www.reactos.org/wiki/File_Bugs) for a guide.
59
60 __NOTE:__ The bug tracker is _not_ for discussions. Please use `#reactos` Freenode IRC channel or our [forum](https://reactos.org/forum).
61
62 ## Contributing
63
64 We are always looking for developers! Check [how to contribute](CONTRIBUTING.md) if you are willing to participate.
65
66 ## More information
67
68 ReactOS is a Free and Open Source operating system based on the Windows architecture,
69 providing support for existing applications and drivers, and an alternative to the current dominant consumer operating system.
70
71 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.
72
73 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.
74
75 More information is available at: https://www.reactos.org.
76
77 Also see the [media/doc](/media/doc/) subdirectory for some sparse notes.
78
79 ## Who is responsible
80
81 Active devs are listed as members of [GitHub organization](https://github.com/orgs/reactos/people).
82 See also the [CREDITS](CREDITS) file for others.
83
84 ## Code mirrors
85
86 The main development is done on [GitHub](https://github.com/reactos/reactos). We have an [alternative mirror](https://git.reactos.org/) in case GitHub is down.
87
88 There is also an obsolete [SVN archive repository](https://svn.reactos.org/svn/reactos?view=revision) that is kept for historical purposes.
89
90 [travis.badge]: https://travis-ci.org/reactos/reactos.svg?branch=master
91 [appveyor.badge]: https://ci.appveyor.com/api/projects/status/github/reactos/reactos?branch=master&svg=true
92 [coverity.badge]: https://scan.coverity.com/projects/205/badge.svg?flat=1
93 [release.badge]: https://img.shields.io/badge/release-0.4.6-brightgreen.svg
94 [license.badge]: https://img.shields.io/badge/license-GNU_GPL_2.0+-blue.svg
95 [sfstats.badge]: https://img.shields.io/sourceforge/dm/reactos.svg
96 [rosbewin.badge]: https://img.shields.io/badge/RosBE_Windows-2.1.5-blue.svg
97 [rosbeunix.badge]: https://img.shields.io/badge/RosBE_Unix-2.1.2-blue.svg
98 [tweetme.badge]: https://img.shields.io/twitter/url/http/shields.io.svg?style=social
99 [flattr.badge]: https://api.flattr.com/button/flattr-badge-large.png
100
101 [travis.link]: https://travis-ci.org/reactos/reactos
102 [appveyor.link]: https://ci.appveyor.com/project/AmineKhaldi/reactos
103 [coverity.link]: https://scan.coverity.com/projects/205
104 [release.link]: https://sourceforge.net/projects/reactos/files/ReactOS/0.4.6
105 [license.link]: https://github.com/reactos/reactos/blob/master/COPYING
106 [sfstats.link]: https://sourceforge.net/projects/reactos
107 [rosbewin.link]: https://sourceforge.net/projects/reactos/files/RosBE-Windows/i386/2.1.5/
108 [rosbeunix.link]: https://sourceforge.net/projects/reactos/files/RosBE-Unix/2.1.2/
109 [tweetme.link]: https://twitter.com/intent/tweet?text=Check%20out%20ReactOS%20-%20Free%20and%20Open%20Source%20Windows%21&url=https%3A%2F%2Fgithub.com%2Freactos%2Freactos&hashtags=ReactOS,opensource,Windows
110 [flattr.link]: https://flattr.com/thing/505443/ReactOS