Skip to content

Commit 01d1ca6

Browse files
authored
Update README.md
1 parent 6fda0bc commit 01d1ca6

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
[![Build Status](https://ci.appveyor.com/api/projects/status/r82c37nc634tnsv9/branch/master?svg=true)](https://ci.appveyor.com/project/rianquinn/hypervisor-13oyg/branch/master)
88
[![Coverage Status](https://coveralls.io/repos/github/Bareflank/hypervisor/badge.svg?branch=master)](https://coveralls.io/github/Bareflank/hypervisor?branch=master)
99
[![Codacy Status](https://api.codacy.com/project/badge/Grade/28ec616803cb4800a4b727b70a3b112f)](https://www.codacy.com/app/rianquinn/hypervisor?utm_source=github.com&utm_medium=referral&utm_content=Bareflank/hypervisor&utm_campaign=Badge_Grade)
10-
[![Coverity Scan Status](https://scan.coverity.com/projects/9857/badge.svg)](https://scan.coverity.com/projects/bareflank-hypervisor)
1110
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/325/badge)](https://bestpractices.coreinfrastructure.org/projects/325)
1211
[![Join the chat at https://gitter.im/Bareflank-hypervisor/Lobby](https://badges.gitter.im/Bareflank-hypervisor/Lobby.svg)](https://gitter.im/Bareflank-hypervisor/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
1312

@@ -50,7 +49,6 @@ that the provided code works as expected. These tests are validated using
5049
test styling via
5150
[Astyle](http://astyle.sourceforge.net), and static / dynamic analysis
5251
via
53-
[Coverity Scan](https://scan.coverity.com/projects/bareflank-hypervisor),
5452
[Clang Tidy](http://clang.llvm.org/extra/clang-tidy/),
5553
[Codacy](https://www.codacy.com),
5654
and
@@ -65,8 +63,7 @@ including support for the
6563
Currently we have support for the following 64bit host operating systems on
6664
Intel _Sandy Bridge_ and above hardware:
6765
- Arch Linux
68-
- Debian 9.x+
69-
- Ubuntu 17.04+
66+
- Ubuntu 17.10+
7067
- Windows 10
7168
- Windows 8.1
7269
- Windows 7
@@ -154,30 +151,23 @@ sudo ln -s /usr/share/clang/run-clang-tidy.py /usr/bin/run-clang-tidy-4.0.py
154151
sudo ln -s /usr/bin/clang-tidy /usr/bin/clang-tidy-4.0
155152
```
156153

157-
#### Ubuntu 17.04 (or Higher):
154+
#### Ubuntu 17.10 (or Higher):
158155
```
159156
sudo apt-get install git build-essential linux-headers-$(uname -r) nasm clang cmake
160157
```
161158

162159
#### Windows (Cygwin):
163-
Visual Studio 2017 doesn't support building drivers, but the WDK 10 doesn't
164-
compile drivers without Visual Studio 2017 installed, so you must install
165-
both Visual Studio 2017 and 2015 to get a complete environment. Also note that
166-
these packages must be installed in the following order:
167-
- [Visual Studio 2015](https://go.microsoft.com/fwlink/?LinkId=615448&clcid=0x409)
168-
- Check "Visual C++"
169-
- [Visual Studio 2017](https://www.visualstudio.com/thank-you-downloading-visual-studio/?sku=Community&rel=15#)
160+
- [Visual Studio 2017 / WDK 10](https://docs.microsoft.com/en-us/windows-hardware/drivers/)
170161
- Check "Desktop development with C++"
171162
- Check "C++ CLI / Support"
172-
- [Visual Studio WDK 10](https://go.microsoft.com/fwlink/p/?LinkId=845980)
173163
- [Cygwin](https://www.cygwin.com/setup-x86_64.exe)
174164

175165
To install Cygwin, simply install using all default settings, and then copy
176166
setup-x86\_64.exe to C:\\cygwin64\\bin. From there, open a Cygwin terminal and
177167
run the following:
178168

179169
```
180-
setup-x86_64.exe -q -P git,make,gcc-core,gcc-g++,nasm,clang,clang++,cmake,python,gettext,bash-completion
170+
setup-x86_64.exe -q -P git,make,gcc-core,gcc-g++,nasm,clang,clang++,cmake,python,gettext
181171
```
182172

183173
After installing the the above packages you must enable test signing mode.
@@ -256,6 +246,11 @@ netsh advfirewall firewall add rule name='SSH Port' dir=in action=allow protocol
256246

257247
## Extended APIs / Hyperkernel
258248

249+
*** **WARNING** *** <br>
250+
The master branch is our development branch and should be considered unstable.
251+
It is possible these additional projects might not compile with master. If you
252+
need a stable branch that works with these repos, please use a tagged release.
253+
259254
Since Bareflank only provides the bare minimum implementation, we have created
260255
two other repositories that extend Bareflank to provide additional
261256
capabilities that you might find useful. The Extended APIs repo provides
@@ -272,6 +267,11 @@ https://github.com/Bareflank/hyperkernel
272267

273268
## Example Extensions
274269

270+
*** **WARNING** *** <br>
271+
The master branch is our development branch and should be considered unstable.
272+
It is possible these additional projects might not compile with master. If you
273+
need a stable branch that works with these repos, please use a tagged release.
274+
275275
To provide examples of how you might extend Bareflank to provide your own custom
276276
functionality, we have provided a couple of examples:
277277

0 commit comments

Comments
 (0)