GNOME.org
 

[dia/neduard/update_readme] Update readme

commit 26b0c227226b1efe1e2c5931e72396bac8b6d8d6
Author: Zander Brown <zbrown gnome org>
Date:   Tue Sep 17 20:06:12 2019 +0100

    Update readme

 AUTHORS     |   8 +++---
 BUILDING.md |  22 ++-------------
 HACKING.md  |  10 +++----
 README.md   |  92 +++++++++++++++++++++++-------------------------------------
 logo.png    | Bin 0 -> 12565 bytes
 5 files changed, 46 insertions(+), 86 deletions(-)
---
diff --git a/AUTHORS b/AUTHORS
index 0fb5d3c4..4c586b05 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -7,13 +7,13 @@ Software projects.
 See the COPYING file in the same directory as this file for the licence.
 
 Dia has been written directly or indirectly by many people; this
-project has been started by Alexander Larsson. 
+project has been started by Alexander Larsson.
 
 Copyright (C) 1998-2000 Alexander Larsson
 Copyright (C) 1999-2001 James Henstridge
 Copyright (C) 1984-2002 Free Software Foundation, Inc.
 Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
-Copyright (C) 1997 Juliusz Chroboczek 
+Copyright (C) 1997 Juliusz Chroboczek
 Copyright (C) 1999 Tim Janik
 Copyright (C) 1999-2002 Lars R. Clausen
 Copyright (C) 1999-2000 Helix Code, Inc.
@@ -29,11 +29,11 @@ Copyright (C) 2001 Jose A Ortega Ruiz
 Copyright (C) 2002 Alejandro Sierra <asierra servidor unam mx>
 Copyright (C) 2002 M.C. Nelson
 Copyright (C) 2003 Vadim Berezniker
+Copyright (C) 2018-19 Zander Brown <zbrown gnome org>
 
 The above list is believed to be complete with respect to copyright
 information. However, many more people have contributed; a more
 complete list of authors of dia can be found by looking at the
-THANKS file, which should exist in any distributed version of
-dia. Alternatively, the authors' names can be found in the dia
+git history. Alternatively, the authors' names can be found in the dia
 About box, or in $(top_srcdir)/app/authors.h.
 
diff --git a/BUILDING.md b/BUILDING.md
index b47e95a9..f2281042 100644
--- a/BUILDING.md
+++ b/BUILDING.md
@@ -1,14 +1,5 @@
 # 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
-http://dia-installer.sourceforge.net and download the precompiled, easily
-installable binary.
-
-Otherwise, please read on :)
-
 ## Requirements
 
 ### General
@@ -23,24 +14,15 @@ For reference, a number of other libraries are recommended for extra features.
 
 - Libxslt allows export through XSLT translation schemas:
   - 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.
+- **Python scripting is also possible** by installing Python 2.7 and pygtk.
+    - Note this will be replaced with libpeas based scripting at some point enabling support for python3 and 
javascript
 
 ### Windows
 
 Currently (as of 1f930b94) the Windows build is under heavy development and not all features are supported.  
Help is always welcome!
 
-The following configuration is supported however: MSYS2 (Pacman v5.1.2) + Mingw64 on Windows 10.
-
-It is recommended you develop Dia in a Virtual Machine since Windows 10 is free to download.
-
-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, 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`
-
-It is also recommended you read https://www.gtk.org/download/windows.php, even though it is for GTK3 instead 
of GTK2.
-
 Assuming you are all set and that pacman is up to date, you'll need to install at least the following 
packages:
 ```
 base-devel
diff --git a/HACKING.md b/HACKING.md
index 81e485f2..e9999f3b 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -6,14 +6,14 @@ larger work --- this is in everyone's interest so that work is
 not duplicated.
 
 For more information on the authors, maintainers, etc., of dia,
-please see the file AUTHORS (dynamically generated).
+please see the file AUTHORS and the git history, after 20 years a lot of people have worked on Dia
 
-Visit the dia webpage at https://gitlab.gnome.org/GNOME/dia
+Visit the dia repository at https://gitlab.gnome.org/GNOME/dia
 for more information on the dia mailing list and many other
 dia-related things.
 
 If you need to alter the list of contributors, documentors,
-etc., the authoritative list is in app/authors.h.
+etc., the main list is in app/authors.h.
 
 
 ## Some comments about the source
@@ -44,8 +44,8 @@ the first argument. This is usually casted to the subtype in the function
 headed (gives all those pita warnings) so that you directly can use the info
 stored in the subclasses. Most ops are quite self-describing, and the code can
 be copy-pasted from an object like the one you're doing. Rendering to
-screen/postscript is done through a 'Renderer' abstraction that can be found
-in `lib/render.h`.
+screen/postscript is done through the 'DiaRenderer' abstraction that can be found
+in `lib/diarenderer.h`.
 
 ### XML based objects
 You can (from version 0.80) create new objects using a SVG like XML languange.
diff --git a/README.md b/README.md
index e0fec941..4ed67943 100644
--- a/README.md
+++ b/README.md
@@ -1,31 +1,28 @@
 # Dia
 
+![logo](logo.png)
+
 ## About
 
-Dia is a program for drawing structured diagrams.
+Dia is a program for drawing diagrams.
+
+Homepage: https://wiki.gnome.org/Apps/Dia
 
-Dia is a GNU program, and is Free Software.  See the COPYING file for the licence.
+Repository: https://gitlab.gnome.org/GNOME/Dia
+
+Dia is a GNU program, and is Free Software. See the COPYING file for the licence.
 
-The current homepage for Dia is https://gitlab.gnome.org/GNOME/dia.  This however
-is fairly new and does not contain a lot of background information.  The previous
-homepage was at https://wiki.gnome.org/Apps/Dia.  Over there you will find a lot
-more information about Dia's history, features, screenshots, GSoC ideas, etc.
-Please have a look at both.
 
 General documentation can be found in the [doc/](doc/) directory.
 
 If you are thinking of contributing (either code or diagrams), please see
-[HACKING](HACKING.md).
+[HACKING.md](HACKING.md).
 
-For compilation and installation instructions please see [BUILDING](BUILDING.md).
+For compilation and installation instructions please see [BUILDING.md](BUILDING.md).
 
 ## Bug reporting
 
-Please use the issue tracker on the GitLab page:
-https://gitlab.gnome.org/GNOME/dia/issues
-
-First, have a look at both the existing open & closed issues: maybe somebody has
-noticed the issues as well, or maybe it's included in a new version.
+Report bugs in GitLab https://gitlab.gnome.org/GNOME/dia/issues, check existing issues (open and closed) to 
check your bug isn't already know (or indeed fixed!)
 
 If the issue is not there, please report it.  Otherwise, give it a "thumbs-up".
 This will us prioritise them.
@@ -39,16 +36,17 @@ 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://irc.gimp.org) on `#dia-editor`
-channel.  Dia has been inactive for a few years now so it is always nice to hear
-from people (still) using it.
+channel.
 
-# Help Wanted
+Dia has been inactive for a few years so it is always nice to hear from people (still) using it.
+
+## Help Wanted
 
 There is a lot of work to be done in order to bring Dia up to date.  Part of
 the reason why Dia has been around for so long is that it is very stable.
 We intend to keep it that way.
 
-## General contributions
+### General contributions
 
 We would love to have more people on-board helping improving Dia.  For that,
 the only requirement is patience :slight_smile:.  Software quality comes not
@@ -60,7 +58,7 @@ belittle your work, it's simply that good things take time and there's no way
 to rush quality.  With that in mind, we welcome all contributions, no matter
 how tiny so please get in touch.
 
-## Windows build maintainer
+### Windows build maintainer
 
 We currently need somebody to look after the Windows builds and packages.
 Most of us use Linux as our main operating system, so if you use Windows and
@@ -68,19 +66,23 @@ would like to program on Dia on Windows, for example, getting it running on
 Visual Studio + Meson, please get in touch.  Note that this involves doing
 full development on Windows and is not limited to just getting it to compile.
 
-## MacOS build maintainer
+### MacOS build maintainer
 
 Similarly to the above, we need somebody to ensure Dia builds and runs well
 on macOS.
 
-## Documentation writers & translators (German, French, Basque, Polish etc)
+### Translators &amp; Documentation writers
+
+Dia is translated over at l10n.gnome.org (module: [dia](https://l10n.gnome.org/module/dia/)), please submit 
translations there instead of as merge requests
 
 Much of the documentation in doc/ is outdated.  We need somebody to go through
 the documents, check what is good, update them and then maintain them.  If you
 enjoy or want to practice technical writing or would be interested in helping
 with the translation we would love to hear from you!
 
-## Testers
+Ideally the docs would be rewritten in mallard instead of docbook
+
+### Testers
 
 One simple way to ensure Dia works well for everybody is to test it on as many
 machines as possible.  This role is simple and is a very good way to get more
@@ -88,42 +90,18 @@ familiar with the Dia codebase.  Plus, the more people Dia works for from
 source, the easier it is for package maintainers and the easier it is for
 anybody to contribute patches:
 
-1. Obtain a machine (ARM, ARM64, x86\_64, SPARC, doesn't matter) in one or more
+  1. Obtain a machine (ARM, ARM64, x86\_64, SPARC, doesn't matter) in one or more
 of the following ways:
-  1. Local laptop, desktop, etc
-  2. Premade box from https://www.osboxes.org/ or similar
-  3. Instal a virtual machine from ISO
-2. Follow the compilation & installation instructions for Dia
-3. See if you can get all the features of Dia running.
-  1. Try various meson options: https://mesonbuild.com/Configuring-a-build-directory.html
-  2. Try to install dependencies in a different order.
-  3. Try a different compiler
-4. If anything is off and hasn't been reported before, let us know!  If it has
+  2. Local laptop, desktop, etc
+  3. Premade box from https://www.osboxes.org/ or similar
+  4. Instal a virtual machine from ISO
+  5. Follow the compilation & installation instructions for Dia
+  6. See if you can get all the features of Dia running.
+  7. Try various meson options: https://mesonbuild.com/Configuring-a-build-directory.html
+  8. Try to install dependencies in a different order.
+  9. Try a different compiler
+  10. If anything is off and hasn't been reported before, let us know!  If it has
 been reported, give the issue a "+1".
-5. If you've tried your best and haven't found anything wrong, also give us a
+  11. If you've tried your best and haven't found anything wrong, also give us a
 shout :-) Let us know what you tried and why you think there aren't any issues
 on the machine you tested it on.
-
-## Code Gardeners
-
-A few issues are marked as [cleanup].  Normally programmers are interested in
-creating things, not removing them.  If you like cleanning code up and believe
-that "perfection is attained, not when there is nothing more to add, but when
-there's nothing left to take away" (Antoine de Saint Exupéry), then by all
-means, we look forward seeing your merge requests.
-
-## Public Relations / Marketing
-
-There are many places where people might ask questions, or discuss about Dia
-that are not actively monitored by developers.  These, for the time being, include:
- - [SourceForge Tickets](https://sourceforge.net/p/dia-installer/_list/tickets)
- - [SourceForge Discussion](https://sourceforge.net/p/dia-installer/discussion/)
- - [Dia 
Bugzilla](https://bugzilla.gnome.org/buglist.cgi?bug_status=UNCONFIRMED&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&bug_status=NEEDINFO&list_id=325564&order=Importance&product=dia&query_format=advanced)
-   - This will end up being removed, but for the time being some might still
-   accidentally use it.
- - Social media, reddit, etc.
-
-If you would like to help, you can do so by monitoring these channels and
-providing support to users. This can be as simple as redirecting them to the
-Gitlab issues if they have a problem (or reporting the problem for them), or
-to the mailing list / IRC if they have a question.
diff --git a/logo.png b/logo.png
new file mode 100644
index 00000000..1bde03c3
Binary files /dev/null and b/logo.png differ
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]