diff --git a/README.md b/README.md index f44dc7b..5505e05 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,47 @@ ![logo](glabels/images/glabels-logo.png) ![gLabels Label Designer](glabels/images/glabels-label-designer.png) -gLabels-qt -========== +******************************************************************************* + +## What is gLabels-qt? + +gLabels-qt is the development repository for the next major version of gLabels (4.0). + +## What's new in glabels-4.0? + +- Based on Qt instead of Gtk. +- Unlike previous versions, glabels-4.0 should be a cross-platform application. So far, it + has been built and tested under Linux and Windows (using MSYS/MINGW toolchain). +- It has a new general UI which helps guide the user through typical workflows. + +## Status + +gLabels-qt has been under off-and-on development since October 2013. +It is still missing several features to bring it in parity with glabels-3.4. These include + +- Barcode objects +- Internationalization +- Product template designer +- Online manual + +## Help Needed + +* Help is needed to add support to build and package glabels for other platforms. These include + + - Windows (VisualStudio) + - Windows (MINGW 64bit) + - Mac + - Linux (flatpak) + - Linux (snap) + - Linux (appimage) + +* Help is needed writing online documentation. + +* Help is needed setting up internationalization and writing translations. + +* Additional internal icon themes. + +* Suggestions. + +* For code contributions, see [docs/HACKING.md](docs/HACKING.md). -Qt/C++ Port of glabels. diff --git a/docs/BUILD-INSTRUCTIONS-LINUX.md b/docs/BUILD-INSTRUCTIONS-LINUX.md index 826045f..6571fee 100644 --- a/docs/BUILD-INSTRUCTIONS-LINUX.md +++ b/docs/BUILD-INSTRUCTIONS-LINUX.md @@ -12,24 +12,15 @@ gLabels Linux Build Instructions > may also need to be installed. Development packages are usually named something like > libraryName-dev or libraryName-devel. -## Cloning/Downloading +## Compile and Install -To clone the gLabels source: +gLabels uses the CMake meta build system. Use the following commands to build and install gLabels: -``` -$ git clone https://github.com/jimevins/glabels-qt.git -``` - - -## Compiling and Install - -gLabels uses the CMake meta build system. Use the following commands to build and install gLabels (assuming you are still in the directory that you ran `git clone` from): - -``` -$ cd ./glabels-qt +
+$ cd glabels_source_directory
 $ mkdir build
 $ cd build
 $ cmake ..
 $ make
 $ sudo make install
-```
+
diff --git a/docs/BUILD-INSTRUCTIONS-WINDOWS.md b/docs/BUILD-INSTRUCTIONS-WINDOWS.md index 162b337..42108eb 100644 --- a/docs/BUILD-INSTRUCTIONS-WINDOWS.md +++ b/docs/BUILD-INSTRUCTIONS-WINDOWS.md @@ -27,22 +27,17 @@ export PATH=/c/Qt/Qt5.6.0/5.6/mingw49_32/bin:${PATH} The exact path will depend on the version of Qt and MINGW you have installed. -### Cloning/Downloading - -To download, select **Download ZIP** on the [glabels-qt Github page](https://github.com/jimevins/glabels-qt). Unzip this file into your MSYS home directory (e.g. */mingw/msys/1.0/home/yourname*). - - -### Compiling and Install +### Compile and Install gLabels uses the CMake meta build system. From the MSYS shell, type the following commands: -``` -$ cd glabels-qt-master +
+$ cd glabels_source_directory
 $ mkdir build
 $ cd build
 $ cmake -G "MSYS Makefiles" ..
 $ make install
-```
+
diff --git a/docs/HACKING.md b/docs/HACKING.md old mode 100755 new mode 100644