aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwilliam341 <[email protected]>2016-07-23 20:10:43 -0700
committerGitHub <[email protected]>2016-07-23 20:10:43 -0700
commit67739a943d9c0be080726cbb39afb84094598326 (patch)
treed00efbd61136e72c1f2245b311637bc916e220a0
parent024ec56765e91d896d25417ed09ebf2a6f131eee (diff)
downloadshiftos-c--67739a943d9c0be080726cbb39afb84094598326.tar.gz
shiftos-c--67739a943d9c0be080726cbb39afb84094598326.tar.bz2
shiftos-c--67739a943d9c0be080726cbb39afb84094598326.zip
Update README.md
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index ed85279..309a0c6 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# ShiftOS
+[![Join the chat at https://gitter.im/MichaelTheShifter/ShiftOS-C-](https://badges.gitter.im/MichaelTheShifter/ShiftOS-C-.svg)](https://gitter.im/MichaelTheShifter/ShiftOS-C-?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build status](https://ci.appveyor.com/api/projects/status/w40gyl8c2x2wy5su/branch/master?svg=true)](https://ci.appveyor.com/project/MichaelTheShifter/shiftos-c/branch/master)
Welcome to the official C# rewrite of the original ShiftOS 0.0.9. It is led by Michael VanOverbeek and developed by the community.
@@ -8,6 +8,12 @@ ShiftOS C# is licensed under the GNU General Public License 3.0. Before making a
Most of the code you'll be using in ShiftOS is documented and Visual Studio will tell you what it all means.
+## Can't build the source code?
+
+There is a bug with the `Baseclass.Contrib.Nuget.Output` package which is a dependency of the GeckoFX webrenderer that causes it to access a DLL that doesn't exist. This will prevent you from compiling the code. To fix it however, I have supplied a copy of the file that's accessing the non-existent DLL in the `source` directory. Copy it to the `source\packages\Baseclass.Contrib.Nuget.Output.2.0.0\build\net40\Baseclass.Contrib.Nuget.Output.targets` file and try rebuilding again.
+
+The reason you'll experience this issue is because the `packages` directory is in the .gitignore file to prevent even worse side effects and because it's normally a bad practice to hold binaries in a source directory on Git. (**Hypocritical note:** I'm a hypocrite for saying that as some dependencies that aren't supplied by NuGet (well they are but we don't use them) don't get brought over to our AppVeyor build server so they have to be supplied in the code or the build will always fail.)
+
## How to contribute
You can contribute by forking the source code to your own repo, and pulling it down to your computer using a Git client. We recommend GitHub for Desktop. You can also use Atlassian SourceTree, or any other Git clients. It's up to you.