From f1b815b3186078d308eb85ce3be253aefb268c04 Mon Sep 17 00:00:00 2001 From: AMurkin Date: Thu, 5 Sep 2019 10:43:27 +0400 Subject: [PATCH] Update links --- ISSUES.md | 2 +- README.md | 8 ++++---- doc/COMPILING/COMPILER_SUPPORT.md | 4 ++-- doc/COMPILING/COMPILING-CMAKE.md | 2 +- doc/COMPILING/COMPILING.md | 8 ++++---- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/ISSUES.md b/ISSUES.md index acf5b679311c..ffea825f4a12 100644 --- a/ISSUES.md +++ b/ISSUES.md @@ -44,7 +44,7 @@ Remember to take part in the discussion of your suggestions. ### Questions -You should direct your questions to the forum or ask on IRC. You should also read the included documentation and additional text files, e.g. `COMPILING.md` if you have problems building. +You should direct your questions to the forum or ask on IRC. You should also read the included documentation and additional text files, e.g. [COMPILING.md](doc/COMPILING/COMPILING.md) if you have problems building. ## Bounties diff --git a/README.md b/README.md index 3e8da4cd4444..d48725c96f87 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,12 @@ The source can either be downloaded as [an archive](https://github.com/CleverRav ## Compile -Please read [COMPILING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING.md) - it covers general information and more specific recipes for Linux, OS X, Windows and BSD. See [doc/COMPILER_SUPPORT.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/doc/COMPILER_SUPPORT.md) for details on which compilers we support. And you can always dig for more information in [doc/](https://github.com/CleverRaven/Cataclysm-DDA/tree/master/doc). +Please read [COMPILING.md](doc/COMPILING/COMPILING.md) - it covers general information and more specific recipes for Linux, OS X, Windows and BSD. See [COMPILER_SUPPORT.md](doc/COMPILING/COMPILER_SUPPORT.md) for details on which compilers we support. And you can always dig for more information in [doc/](https://github.com/CleverRaven/Cataclysm-DDA/tree/master/doc). We also have the following build guides: -* Building on Windows with `MSYS2` at [COMPILING-MSYS.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-MSYS.md) -* Building on Windows with `vcpkg` at [COMPILING-VS-VCPKG.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-VS-VCPKG.md) -* Building with `cmake` at [COMPILING-CMAKE.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-CMAKE.md) (*unofficial guide*) +* Building on Windows with `MSYS2` at [COMPILING-MSYS.md](doc/COMPILING/COMPILING-MSYS.md) +* Building on Windows with `vcpkg` at [COMPILING-VS-VCPKG.md](doc/COMPILING/COMPILING-VS-VCPKG.md) +* Building with `cmake` at [COMPILING-CMAKE.md](doc/COMPILING/COMPILING-CMAKE.md) (*unofficial guide*) ## Contribute diff --git a/doc/COMPILING/COMPILER_SUPPORT.md b/doc/COMPILING/COMPILER_SUPPORT.md index 3597d77320a7..f2b78d0efee6 100644 --- a/doc/COMPILING/COMPILER_SUPPORT.md +++ b/doc/COMPILING/COMPILER_SUPPORT.md @@ -31,7 +31,7 @@ currently used both in the tests and for the Windows release binaries. ## MSYS2 -MSYS2 is [a way to build the project](../COMPILING-MSYS.md) on Windows. It +MSYS2 is [a way to build the project](COMPILING-MSYS.md) on Windows. It currently offers gcc at versions 7 or higher. MSYS also provides clang. We don't currently support using clang here, but @@ -39,4 +39,4 @@ work to that end is welcome. ## Visual Studio -We also support [Visual Studio](../COMPILING-VS-VCPKG.md) 2015 Update 3 and above. +We also support [Visual Studio](COMPILING-VS-VCPKG.md) 2015 Update 3 and above. diff --git a/doc/COMPILING/COMPILING-CMAKE.md b/doc/COMPILING/COMPILING-CMAKE.md index 5c23c529dfa4..f4d2f7b0d69c 100644 --- a/doc/COMPILING/COMPILING-CMAKE.md +++ b/doc/COMPILING/COMPILING-CMAKE.md @@ -3,7 +3,7 @@ **WARNING**: CMake build is **NOT** official and should be used for *dev purposes ONLY*. For official way to build CataclysmDDA See: - * [COMPILING.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING.md) + * [COMPILING.md](COMPILING.md) #Contents diff --git a/doc/COMPILING/COMPILING.md b/doc/COMPILING/COMPILING.md index 59f17a6ac5a0..0b07bc443fed 100644 --- a/doc/COMPILING/COMPILING.md +++ b/doc/COMPILING/COMPILING.md @@ -258,7 +258,7 @@ Your directory tree should look like: Populated with respective frameworks, dylibs and headers. Tested lib versions are libintl.8.dylib for gettext, libncurses.5.4.dylib for ncurses. These libs were obtained from `homebrew` binary distribution at OS X 10.11 -Frameworks were obtained from SDL official website as described in the next [section](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING.md#sdl) +Frameworks were obtained from SDL official website as described in the next [section](#sdl) ### Building (SDL) @@ -574,19 +574,19 @@ Open Terminal's preferences, turn on "Use bright colors for bold text" in "Prefe ## Building with Visual Studio -See [COMPILING-VS-VCPKG.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-VS-VCPKG.md) for instructions on how to set up and use a build environment using Visual Studio on windows. +See [COMPILING-VS-VCPKG.md](COMPILING-VS-VCPKG.md) for instructions on how to set up and use a build environment using Visual Studio on windows. This is probably the easiest solution for someone used to working with Visual Studio and similar IDEs. ## Building with MSYS2 -See [COMPILING-MSYS.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-MSYS.md) for instructions on how to set up and use a build environment using MSYS2 on windows. +See [COMPILING-MSYS.md](COMPILING-MSYS.md) for instructions on how to set up and use a build environment using MSYS2 on windows. MSYS2 strikes a balance between a native Windows application and a UNIX-like environment. There's some command-line tools that our project uses (notably our JSON linter) that are harder to use without a command-line environment such as what MSYS2 or CYGWIN provide. ## Building with CYGWIN -See [COMPILING-CYGWIN.md](https://github.com/CleverRaven/Cataclysm-DDA/blob/master/COMPILING-CYGWIN.md) for instructions on how to set up and use a build environment using CYGWIN on windows. +See [COMPILING-CYGWIN.md](COMPILING-CYGWIN.md) for instructions on how to set up and use a build environment using CYGWIN on windows. CYGWIN attempts to more fully emulate a POSIX environment, to be "more unix" than MSYS2. It is a little less modern in some respects, and lacks the convenience of the MSYS2 package manager.