[dia/neduard-neduard/update_dev_docs-patch-80111] Markdown fixes & minor updates.
- From: Eduard <neduard src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [dia/neduard-neduard/update_dev_docs-patch-80111] Markdown fixes & minor updates.
- Date: Thu, 31 Jan 2019 16:00:36 +0000 (UTC)
commit 1c99437308732699ef57a2c2f7c10fb5942a7771
Author: Eduard <eddnicodei gmail com>
Date: Thu Jan 31 16:00:11 2019 +0000
Markdown fixes & minor updates.
BUILDING.md | 15 +++++++--------
README.md | 2 +-
2 files changed, 8 insertions(+), 9 deletions(-)
---
diff --git a/BUILDING.md b/BUILDING.md
index 62cd2397..c6099eac 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -5,13 +5,13 @@ compiling/extending it, you are in the wrong place. Please go to
http://dia-installer.sourceforge.net and download the precompiled, easily
installable binary.
-Users of OSes where compilation is easy, please read on :)
+Otherwise, please read on :)
# Requirements
## General
-Dia is currently built using [meson](https://github.com/mesonbuild/meson). Meson can be installed either
via packages or run directly from source code. Please take 2 minutes to read their [Quick
Guide](https://mesonbuild.com/Quick-guide.html). It provides all the needed information to obtain meson and
run it.
+Dia is currently built using [meson](https://github.com/mesonbuild/meson). Meson can be installed either
via a package manager or run directly from source code. Please take 2 minutes to read their [Quick
Guide](https://mesonbuild.com/Quick-guide.html). It provides all the needed information to obtain meson and
run it.
Build requirements are documented in the root [meson.build](/meson.build) file. Meson is designed to be
readable so please have a skim through the file. Some dependencies are required, while others are optional.
@@ -40,7 +40,7 @@ It is recommended you develop Dia in a Virtual Machine since Windows 10 is free
For all git-related operations, it is recommended you use https://gitforwindows.org/ instead of MSYS2.
-Please read MSYS2 instructions on https://www.msys2.org/ and their wiki carefully before installing MSYS2.
They have three different environments: MSYS2, Ming64 and Ming32. **ALL** packages must be installed from
MSYS2 environment, and all development needs to be performed from Ming64 one.
+Please read MSYS2 instructions on https://www.msys2.org/ and their wiki carefully before installing MSYS2.
They have three different environments: MSYS2, Mingw64 and Mingw32. **ALL** packages must be installed from
MSYS2 environment, and all development needs to be performed from Mingw64 one.
It is also recommended you use the source version of meson (https://github.com/mesonbuild/meson) rather than
using the MSYS2 one. However, it is still recommended you install meson from `pacman` since it has a few
dependencies, most notably `ninja`
@@ -71,7 +71,7 @@ path/to/meson.py build -Dprefix=`pwd`/build/install
cd build
ninja install
# Wait for meson to configure, build and install
-# If missing dependencies, please check [Requirements section](#Requirements)
+# If missing dependencies, please check "Requirements" section
./install/bin/dia
```
@@ -81,9 +81,8 @@ cd path/to/dia
path/to/meson.py build
cd build
ninja
-# Wait for meson to configure and build
-# If missing dependencies, please check [Requirements section](#Requirements)
./run_with_dia_env ./app/dia
+```
## Running tests
@@ -92,8 +91,8 @@ Build dia then simply do `ninja test`.
## Windows issues
The most common issue currently on MSYS2 is that paths are incorrect. There are two potential types of
issues that you need to be aware of:
-1. libdia.dll not found. This happens because PATH does not contain the directory where libdia.dll is
located. Simply add that directory to PATH, e.g. `PATH=$(pwd)/lib/:$PATH ./run_with_dia_env ./app/dia`
-2. Python site module not found. This is because PYTHONPATH or PYTHONHOME are not set. Simply set both to
/mingw64/lib/python2.7 and that should resolve the issue.
+1. "libdia.dll not found": This happens because PATH does not contain the directory where libdia.dll is
located. Simply add that directory to PATH, e.g. `PATH=$(pwd)/lib/:$PATH ./run_with_dia_env ./app/dia`
+2. "Python site module not found": This is because PYTHONPATH or PYTHONHOME are not set. Simply set both
to /mingw64/lib/python2.7 and that should resolve the issue.
# Installing
diff --git a/README.md b/README.md
index 451918cc..d1f32c0b 100644
--- a/README.md
+++ b/README.md
@@ -30,5 +30,5 @@ Please feel free to send us comments/feedback/questions on our mailing list:
https://mail.gnome.org/mailman/listinfo/dia-list
If you don't want to send a full email or just want to say "Hi!", we also hang out on IRC on GimpNet
-[irc.gimp.org](irc.gimp.org) on `#dia-editor` channel. Dia has been inactive for a few years now so
+[irc.gimp.org](irc://irc.gimp.org) on `#dia-editor` channel. Dia has been inactive for a few years now so
it is very nice when we hear from people using it.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]