From 506af3ac6df85c8705c82b46cf33e5c80bfb2dfa Mon Sep 17 00:00:00 2001 From: John Fultz Date: Sun, 12 Aug 2018 19:18:20 -0500 Subject: [PATCH] Update readmes to reflect new requirements. --- HowToBuild.md | 13 +++++-------- Readme.md | 4 ++-- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/HowToBuild.md b/HowToBuild.md index 2d68c13..5e12dc0 100644 --- a/HowToBuild.md +++ b/HowToBuild.md @@ -4,12 +4,12 @@ GitLink has two buildable components: the documentation, and a shared library component which is loaded via LibraryLink. This document covers only how to build and run the shared library component. #### Prerequisites -* Version 10.1 or greater of Mathematica or Wolfram Desktop. -* A C++ compiler supporting the C++11 standard and the C Compiler Driver feature of the Wolfram Language. - * Visual Studio 2013 or later is preferred under Windows. +* Version 11.1 or greater of Mathematica or Wolfram Desktop (earlier versions might work but have not been tested). +* A C++ compiler supporting the C++14 standard and the C Compiler Driver feature of the Wolfram Language. + * Visual Studio 2015 or later is preferred under Windows. * Xcode bundled with a 10.9 or later SDK is preferred on Mac. - * gcc 4.8.4 or above on Linux should work. -* A built version of libgit2. While it's possible to use a dynamic library build, we prefer to use the static library build, which requires a small change to the default libgit2 cmake files. + * gcc 5.0 or above on Linux should work. +* A built version of libgit2 (0.26.x or 0.27.x). While it's possible to use a dynamic library build, we prefer to use the static library build, which requires a small change to the default libgit2 cmake files. #### Building GitLink * Open the file src/build.wl in the Wolfram system. @@ -24,6 +24,3 @@ GitLink has two buildable components: the documentation, and a shared library co * Load the package using `Get` or `Needs`. E.g., ``Get["GitLink`"]``. * When loading the package this way, the system may choose to try to load the unbuilt source documentation pages rather than any final built documentation pages. If you want to use the documentation while in this state, it may be easiest to simply run another copy of the Wolfram system where you can access the documentation. * You can test that you're running the library you think you are, and the features which were used to compile libgit2, by evaluating `$GitLibraryInformation` and examining the results. - -#### Notes -* The Mac version builds two binaries. One is compatible with 10.3 and earlier, while the other is compatible with 10.4 and later. You only need the one compatible with your system for things to work. The difference is that the newer build uses `libc++` while the older one uses `libstdc++`. \ No newline at end of file diff --git a/Readme.md b/Readme.md index 011db24..7b5ed8e 100644 --- a/Readme.md +++ b/Readme.md @@ -3,7 +3,7 @@ ![GitLinkLogo](logo.png) -GitLink is a package for integrating [git](https://git-scm.com/) functionality into the [Wolfram Language](https://www.wolfram.com/language/). GitLink supports 10.4 and later versions of Wolfram Language deployments for the desktop, including [Wolfram Desktop](https://www.wolfram.com/desktop/) and [Mathematica](https://www.wolfram.com/mathematica/). +GitLink is a package for integrating [git](https://git-scm.com/) functionality into the [Wolfram Language](https://www.wolfram.com/language/). GitLink supports 11.1 and later versions of Wolfram Language deployments for the desktop, including [Wolfram Desktop](https://www.wolfram.com/desktop/) and [Mathematica](https://www.wolfram.com/mathematica/). ### Installing the GitLink release @@ -42,7 +42,7 @@ GitLink is implemented on top of the excellent [libgit2 project](https://libgit2 GitLink is ultimately slated to become a part of the official Wolfram Language release. Before that happens, more functionality will need to be implemented, and the product will be subjected to our rigorous design review process, which may introduce incompatibilities with the existing version. However, it is our intent to keep the source open even after we ship the final product, and to continue to be welcome to community contributions that can improve future versions of GitLink. -Major areas of GitLink which are not yet implemented include support for diff, blame, rebase, and config functionality. Additionally, we need to improve support for various git protocols for pushing and fetching. +Major areas of GitLink which are not yet implemented include support for diff, blame, rebase, submodule, and config functionality. Additionally, we need to improve support for various git protocols for pushing and fetching. ### More...