From: Alexander Shaposhnikov Date: Mon, 9 Oct 2017 00:07:40 +0000 (+0300) Subject: README.md: Added badges X-Git-Tag: 0.4.8-dev~137 X-Git-Url: https://git.reactos.org/?p=reactos.git;a=commitdiff_plain;h=7cffc6d5ce69ae02fe92e9644d5584931ab49d49 README.md: Added badges Added various badges: CI, SourceForge, GitHub stats etc. Centered image Fixed some typos --- diff --git a/README.md b/README.md index 80825631caf..8894fdb916b 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,13 @@ -# ReactOS Project +# ReactOS Project [![release.badge]][release.link] [![sfstats.badge]][sfstats.link] [![travis.badge]][travis.link] [![appveyor.badge]][appveyor.link] -Current version: __0.4.6__ -![ReactOS Logo](https://reactos.org/wiki/images/0/02/ReactOS_logo.png) +

+ +

+ +[![license.badge]][license.link] [![ghcontrib.badge]]() [![ghstats.badge]]() [![commits.badge]]() [![coverity.badge]][coverity.link] ## Quick Links + - [Website](https://reactos.org) - [Wiki](https://reactos.org/wiki) - [Forum](https://reactos.org/forum) @@ -13,27 +17,22 @@ 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://spdx.org/licenses/GPL-2.0+.html). -## Building +## Building [![rosbewin.badge]][rosbewin.link] [![rosbeunix.badge]][rosbeunix.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 +43,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. @@ -74,15 +70,38 @@ 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/) 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 +[commits.badge]: https://img.shields.io/github/commits-since/reactos/reactos/0.4.7-dev.svg +[release.badge]: https://img.shields.io/badge/release-0.4.6-brightgreen.svg +[license.badge]: https://img.shields.io/badge/license-GNU_GPL_2.0+-blue.svg +[sfstats.badge]: https://img.shields.io/sourceforge/dm/reactos.svg +[ghstats.badge]: https://img.shields.io/github/commit-activity/4w/reactos/reactos.svg +[ghcontrib.badge]: https://img.shields.io/github/contributors/reactos/reactos.svg +[rosbewin.badge]: https://img.shields.io/badge/RosBE_Windows-2.1.5-blue.svg +[rosbeunix.badge]: https://img.shields.io/badge/RosBE_Unix-2.1.2-blue.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 +[release.link]: https://sourceforge.net/projects/reactos/files/ReactOS/0.4.6 +[license.link]: https://spdx.org/licenses/GPL-2.0+.html +[sfstats.link]: https://sourceforge.net/projects/reactos +[ghstats.link]: https://github.com/reactos/reactos/graphs/commit-activity +[ghcontrib.link]: https://github.com/reactos/reactos/graphs/contributors +[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/