From 3ee52836c69bb34bb10f1dd9c8fbec086defafad Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Sun, 17 Dec 2017 19:29:41 +0100 Subject: [PATCH] Link Git-specific notes from the main README Rename BuildGit.txt to README-GIT.md, which is a more standard name, and a better format for viewing this file online, e.g. from GitHub Web UI, and link it from the main README to make it easier to find. --- BuildGit.txt | 17 ----------------- README-GIT.md | 17 +++++++++++++++++ README.md | 10 ++++++++++ 3 files changed, 27 insertions(+), 17 deletions(-) delete mode 100644 BuildGit.txt create mode 100644 README-GIT.md diff --git a/BuildGit.txt b/BuildGit.txt deleted file mode 100644 index 2ffc25e263..0000000000 --- a/BuildGit.txt +++ /dev/null @@ -1,17 +0,0 @@ ------------------------------------------------------------------------- - How to build the sources from git ------------------------------------------------------------------------- - -When cloning the repository, use --recurse-submodules option. If you had -already cloned it without it, run "git submodule update --init" to also -get all 3rd party libraries code. - -Before building from git sources under Windows, you need to copy the -file include/wx/msw/setup0.h to include/wx/msw/setup.h. This is -necessary in order to allow having local modifications to the latter -file without showing it as modified, as it is not under version -control. - -After doing this, please proceed with the build as with any official -release, i.e. follow the instructions in the install.txt file in -docs/gtk, docs/msw and so on. diff --git a/README-GIT.md b/README-GIT.md new file mode 100644 index 0000000000..dca9fb2a94 --- /dev/null +++ b/README-GIT.md @@ -0,0 +1,17 @@ +Building from Git Sources +------------------------- + +Please use `--recurse-submodules` option with the initial `git clone`. If you +had already cloned the repository without this option, please run `git +submodule update --init` to also get all 3rd party libraries code. + +Before building from Git sources under Windows, you need to copy the +file `include/wx/msw/setup0.h` to `include/wx/msw/setup.h`. This is +necessary in order to allow having local modifications to the latter +file without showing it as modified, as it is not under version +control. + +After doing this, please proceed with the build as with any official +release, i.e. follow the instructions in the port-specific files, e.g. +[wxMSW](docs/msw/install.txt), [wxGTK](docs/gtk/install.txt), +[wxOSX](docs/osx/install.txt) and so on. diff --git a/README.md b/README.md index 83a1618656..762261e0dd 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,16 @@ is a modified version of LGPL explicitly allowing not distributing the sources of an application using the library even in the case of static linking. +Building +-------- + +For building the library, please see platform-specific documentation under +`docs/` directory. + +If you're building the sources checked out from Git, and not from a released +versions, please see these additional [Git-specific notes](README-GIT.md). + + Further information -------------------