[dia/neduard/update_dev_docs: 15/17] #30: Update section headers.
- From: Eduard <neduard src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [dia/neduard/update_dev_docs: 15/17] #30: Update section headers.
- Date: Tue, 12 Feb 2019 17:59:47 +0000 (UTC)
commit f8c82c719200a2e713efbb1981caebc771e9555d
Author: Eduard <eddnicodei gmail com>
Date: Sun Feb 10 21:46:27 2019 +0000
#30: Update section headers.
BUILDING.md | 26 ++++++++++++++------------
README.md | 8 +++++---
2 files changed, 19 insertions(+), 15 deletions(-)
---
diff --git a/BUILDING.md b/BUILDING.md
index c6099eac..d46b6eed 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,4 +1,6 @@
-# NOTE FOR WINDOWS USERS
+# Compiling Dia from source
+
+## NOTE FOR WINDOWS USERS
If you are reading this and just want to use Dia rather than
compiling/extending it, you are in the wrong place. Please go to
@@ -7,9 +9,9 @@ installable binary.
Otherwise, please read on :)
-# Requirements
+## Requirements
-## General
+### General
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.
@@ -30,7 +32,7 @@ For reference, a number of other libraries are recommended for extra features.
- ftp://ftp.gnome.org/pub/GNOME/sources/libxslt/
- **Python scripting is also possible** by installing Python 2.7 (note that meson requires python 3,
therefore python2 needs to be explicitly installed) and pygtk.
-## Windows
+### Windows
Currently (as of 1f930b94) the Windows build is under heavy development and not all features are supported.
Help is always welcome!
@@ -58,24 +60,24 @@ intltool
You might need to install additional packages. Please file an issue / merge request with the updated
packages to ensure others know what to install also.
-# Building and Running
+## Building and Running
Please make sure you at least skim the Meson [Quick Guide](https://mesonbuild.com/Quick-guide.html) before
building.
There are currently (as of 1f930b94) two ways to run Dia:
-## 1. Installing to a local prefix
+### 1. Installing to a local prefix
```
cd path/to/dia
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
+## Wait for meson to configure, build and install
+## If missing dependencies, please check "Requirements" section
./install/bin/dia
```
-## 2. Using `run_with_dia_env` (recommended only on *nix)
+### 2. Using `run_with_dia_env` (recommended only on *nix)
```
cd path/to/dia
path/to/meson.py build
@@ -84,16 +86,16 @@ ninja
./run_with_dia_env ./app/dia
```
-## Running tests
+### Running tests
Build dia then simply do `ninja test`.
-## Windows issues
+### 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.
-# Installing
+## Installing
Simply do `ninja install`.
\ No newline at end of file
diff --git a/README.md b/README.md
index dbb3e43f..38e1db40 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-# About
+# Dia
+
+## About
Dia is a program for drawing structured diagrams.
@@ -17,7 +19,7 @@ If you are thinking of contributing (either code or diagrams), please see
For compilation and installation instructions please see [BUILDING](BUILDING.md).
-# Bug reporting
+## Bug reporting
Please use the issue tracker on the GitLab page:
https://gitlab.gnome.org/GNOME/dia/issues
@@ -28,7 +30,7 @@ noticed the issues as well, or maybe it's included in a new version.
If the issue is not there, please report it. Otherwise, give it a "thumbs-up".
This will us prioritise them.
-# Contacting us
+## Contacting us
If you use Dia, we would love to hear from you!
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]