X-Git-Url: https://git.reactos.org/?p=reactos.git;a=blobdiff_plain;f=README.md;h=bd4f225563b31d48f7df1c791fd98ea047106aa1;hp=4e01ecfecbf5ea5946a54e13fa34b2d0ba4373fd;hb=221fc8fd301c79023c96e7f63e56f8e767804956;hpb=c609406c2fa73ccabb3b21462ebef85f9a40762e diff --git a/README.md b/README.md index 4e01ecfecbf..bd4f225563b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,32 @@ -# ReactOS Project +

+ +

+ +--- + +

+ + Release 0.4.7 Release + + + Download ReactOS + + + SourceForge Download + + + License + + + Donate + + + Follow on Twitter + +

+ +## Quick Links -Current version: __0.4.6__ -![ReactOS Logo](https://reactos.org/wiki/images/0/02/ReactOS_logo.png) - -## Quick Links - [Website](https://reactos.org) - [Wiki](https://reactos.org/wiki) - [Forum](https://reactos.org/forum) @@ -13,27 +36,24 @@ Current version: __0.4.6__ ## What is ReactOS? -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). +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). + +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. -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. +The code of ReactOS is licensed under [GNU GPL 2.0](https://github.com/reactos/reactos/blob/master/COPYING). -The code of ReactOS is licensed under [GNU GPL 2.0+](https://spdx.org/licenses/GPL-2.0+.html). +## Building -## Building +[![appveyor.badge]][appveyor.link] [![travis.badge]][travis.link] [![rosbewin.badge]][rosbewin.link] [![rosbeunix.badge]][rosbeunix.link] [![coverity.badge]][coverity.link] -To build the system it is strongly advised to use the _ReactOS Build Environment -(RosBE)._ 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 +To build the system it is strongly advised to use the _ReactOS Build Environment (RosBE)._ +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. -Alternatively one can use Microsoft Visual C++ (MSVC) version 2010+. Building with MSVC is covered here: https://www.reactos.org/wiki/Building_with_MSVC +Alternatively one can use Microsoft Visual C++ (MSVC) version 2010+. Building with MSVC is covered here: https://www.reactos.org/wiki/Building_with_MSVC. ### Binaries -To build ReactOS you must use run `configure` script in the directory you want to have builds. Choose `configure.cmd` or `configure.sh` depending on your system. Then run `ninja ` to build a module you want or just `ninja` to build all modules. +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 ` to build a module you want or just `ninja` to build all modules. ### Bootable images @@ -44,14 +64,11 @@ See ["Building ReactOS"](http://www.reactos.org/wiki/Building_ReactOS) for more ## Installing -ReactOS can only be installed on a machine that has a FAT16 or FAT32 partition -as the active (bootable) partition. 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. ReactOS Setup can format the partitions if -needed. +ReactOS currently can only be installed on a machine that has a FAT16 or FAT32 partition as the active (bootable) partition. +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. +ReactOS Setup can format the partitions if needed. -To install ReactOS from the bootable CD distribution, extract the archive -contents. Then burn the CD image, boot from it, and follow instructions. +To install ReactOS from the bootable CD distribution, extract the archive contents. Then burn the CD image, boot from it, and follow the instructions. See ["Installing ReactOS"](https://www.reactos.org/wiki/Installing_ReactOS) Wiki page or [INSTALL](INSTALL) for more details. @@ -63,6 +80,12 @@ See ["File Bugs"](https://www.reactos.org/wiki/File_Bugs) for a guide. __NOTE:__ The bug tracker is _not_ for discussions. Please use `#reactos` Freenode IRC channel or our [forum](https://reactos.org/forum). +## Contributing ![prwelcome.badge] + +We are always looking for developers! Check [how to contribute](CONTRIBUTING.md) if you are willing to participate. + +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). + ## More information ReactOS is a Free and Open Source operating system based on the Windows architecture, @@ -74,15 +97,28 @@ ReactOS is also not "yet another OS". It does not attempt to be a third player l More information is available at: https://www.reactos.org. -Also see the [media\doc](/media/doc/) subdirectory for some sparse notes. +Also see the [media/doc](/media/doc/) subdirectory for some sparse notes. ## Who is responsible Active devs are listed as members of [GitHub organization](https://github.com/orgs/reactos/people). -Also see the [CREDITS](CREDITS) file for others. +See also the [CREDITS](CREDITS) file for others. ## Code mirrors -The main development is done on [GitHub](https://github.com/reactos/reactos). We have an [alternative mirror](https://git.reactos.org/) it case GitHub is down. +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. There is also an obsolete [SVN archive repository](https://svn.reactos.org/svn/reactos?view=revision) that is kept for historical purposes. + +[travis.badge]: https://travis-ci.org/reactos/reactos.svg?branch=master +[appveyor.badge]: https://ci.appveyor.com/api/projects/status/github/reactos/reactos?branch=master&svg=true +[coverity.badge]: https://scan.coverity.com/projects/205/badge.svg?flat=1 +[rosbewin.badge]: https://img.shields.io/badge/RosBE_Windows-2.1.5-0688CB.svg +[rosbeunix.badge]: https://img.shields.io/badge/RosBE_Unix-2.1.2-0688CB.svg +[prwelcome.badge]: https://img.shields.io/badge/PR-welcome-0688CB.svg + +[travis.link]: https://travis-ci.org/reactos/reactos +[appveyor.link]: https://ci.appveyor.com/project/AmineKhaldi/reactos +[coverity.link]: https://scan.coverity.com/projects/205 +[rosbewin.link]: https://sourceforge.net/projects/reactos/files/RosBE-Windows/i386/2.1.5/ +[rosbeunix.link]: https://sourceforge.net/projects/reactos/files/RosBE-Unix/2.1.2/