[FONTS] Add Source Sans font family.
[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-0411-released">
11 <img alt="ReactOS 0.4.11 Release" src="https://img.shields.io/badge/release-0.4.11-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/donating">
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
40 ## What is ReactOS?
41
42 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).
43
44 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.
45
46 The code of ReactOS is licensed under [GNU GPL 2.0](https://github.com/reactos/reactos/blob/master/COPYING).
47
48 ## Building
49
50 [![appveyor.badge]][appveyor.link] [![travis.badge]][travis.link] [![rosbewin.badge]][rosbewin.link] [![rosbeunix.badge]][rosbeunix.link] [![coverity.badge]][coverity.link]
51
52 To build the system it is strongly advised to use the _ReactOS Build Environment (RosBE)._
53 Up-to-date versions for Windows and for Unix/GNU-Linux are available from our download page at: ["Build Environment"](http://www.reactos.org/wiki/Build_Environment).
54
55 Alternatively one can use Microsoft Visual C++ (MSVC) version 2010+. Building with MSVC is covered here: ["Visual Studio or Microsoft Visual C++"](https://www.reactos.org/wiki/CMake#Visual_Studio_or_Microsoft_Visual_C.2B.2B).
56
57 ### Binaries
58
59 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.
60
61 ### Bootable images
62
63 To build a bootable CD image run `ninja bootcd` from the
64 build directory. This will create a CD image with a filename `bootcd.iso`.
65
66 See ["Building ReactOS"](http://www.reactos.org/wiki/Building_ReactOS) for more details.
67
68 You can always download fresh binary builds of bootable images from the ["Daily builds"](https://www.reactos.org/getbuilds/) page.
69
70 ## Installing
71
72 By default, ReactOS currently can only be installed on a machine that has a FAT16 or FAT32 partition as the active (bootable) partition.
73 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.
74 ReactOS Setup can format the partitions if needed.
75
76 Starting 0.4.10, ReactOS can be installed using the BtrFS file system. But
77 consider this as an experimental feature and thus regressions not triggered on
78 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://www.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://www.reactos.org/wiki/File_Bugs) for a guide.
89
90 __NOTE:__ The bug tracker is _not_ for discussions. Please use `#reactos` Freenode IRC channel or our [forum](https://reactos.org/forum).
91
92 ## Contributing ![prwelcome.badge]
93
94 We are always looking for developers! Check [how to contribute](CONTRIBUTING.md) if you are willing to participate.
95
96 You can also support ReactOS by [donating](https://reactos.org/donating)! We rely on our backers to maintain our servers and accelerate development by [hiring full-time devs](https://reactos.org/node/785).
97
98 ## More information
99
100 ReactOS is a Free and Open Source operating system based on the Windows architecture,
101 providing support for existing applications and drivers, and an alternative to the current dominant consumer operating system.
102
103 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.
104
105 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.
106
107 More information is available at: [reactos.org](https://www.reactos.org).
108
109 Also see the [media/doc](/media/doc/) subdirectory for some sparse notes.
110
111 ## Who is responsible
112
113 Active devs are listed as members of [GitHub organization](https://github.com/orgs/reactos/people).
114 See also the [CREDITS](CREDITS) file for others.
115
116 ## Code mirrors
117
118 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.
119
120 There is also an obsolete [SVN archive repository](https://svn.reactos.org/reactos/) that is kept for historical purposes.
121
122 [travis.badge]: https://travis-ci.org/reactos/reactos.svg?branch=master
123 [appveyor.badge]: https://ci.appveyor.com/api/projects/status/github/reactos/reactos?branch=master&svg=true
124 [coverity.badge]: https://scan.coverity.com/projects/205/badge.svg?flat=1
125 [rosbewin.badge]: https://img.shields.io/badge/RosBE_Windows-2.1.6-0688CB.svg
126 [rosbeunix.badge]: https://img.shields.io/badge/RosBE_Unix-2.1.2-0688CB.svg
127 [prwelcome.badge]: https://img.shields.io/badge/PR-welcome-0688CB.svg
128
129 [travis.link]: https://travis-ci.org/reactos/reactos
130 [appveyor.link]: https://ci.appveyor.com/project/AmineKhaldi/reactos
131 [coverity.link]: https://scan.coverity.com/projects/205
132 [rosbewin.link]: https://sourceforge.net/projects/reactos/files/RosBE-Windows/i386/2.1.6/
133 [rosbeunix.link]: https://sourceforge.net/projects/reactos/files/RosBE-Unix/2.1.2/