From ded9feea4a6a4c4a5df09d0b05e21618edaefa1d Mon Sep 17 00:00:00 2001 From: MarPiRK Date: Wed, 22 Apr 2015 22:04:14 +0200 Subject: [PATCH] README update with link to Trello page Also some markdown changes --- README.md | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5f9e4ae7..5d9317e4 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,15 @@ Description Xournal++ is not Xournal! It is a ground-up rewrite of Xournal in a different language (C++ instead of C). -The purpose was to create a more flexible application that significantly extends the functionality of Xournal. +The purpose was to create a more flexible application that significantly extends +the functionality of Xournal. + At the moment, Xournal is very stable software while Xournal++ is not. -If you want stability, you might be more interested in the original Xournal project, which you can find at -sourceforge or, for some in-development features of Xournal, at -github.com/dmgerman/xournal. +If you want stability, you might be more interested in the original Xournal +project, which you can find at +[sourceforge](http://sourceforge.net/projects/xournal/) +or, for some in-development features of Xournal, at +[github.com/dmgerman/xournal](https://github.com/dmgerman/xournal). New features in Xournal++ include: @@ -21,14 +25,18 @@ New features in Xournal++ include: * advanced page sorting (a sidebar, page up/down, etc.) * bug reporting, autosave, and auto backup tools -Hopefully you enjoy it! +Hopefully you'll enjoy it! +Building +--------------------- At the moment compiling Xournal++ from source is tricky business. -You should therefore first visit the wiki in order to see if there is a known working guide for your system: -Xournal++ Wiki. -There will be some binaries appearing in the near future, so ideally you can make use of those as well. -They'll be at Xournal++ releases. +You should therefore first visit the wiki in order to see if there is a known +working guide for your system: +[Xournal++ Wiki](https://github.com/xournalpp/xournalpp/wiki/). +There will be some binaries appearing in the near future, so ideally you can +make use of those as well. +They'll be at [Xournal++ releases](https://github.com/xournalpp/xournalpp/releases). If at a loss, you can try to build with ```bash @@ -68,8 +76,13 @@ worked for me. By far the most hacked together part of development is the use of an internal libpoppler package to compile static libpoppler.a files, and build them into the final xournalpp executable. We had to do this because the libpoppler-dev install -on many systems just didn't include the headers we were used to access the PDF api. -Fortunately even though compile time is greatly increased, and source code size is large, -the final executable is still very reasonably sized, and it is much more portable in this way. +on many systems just didn't include the headers we were used to access the PDF +api. Fortunately even though compile time is greatly increased, and source code +size is large, the final executable is still very reasonably sized, and it is +much more portable in this way. + +See [Github:xournalpp](http://github.com/xournalpp/xournalpp) for current +development. -See Github:xournalpp for current development. +See our [Trello page](https://trello.com/xournal) for current roadmap and future +developement ideas.