From ae876bc16479741d687ab45f237b59efd664e0f6 Mon Sep 17 00:00:00 2001 From: markuspg Date: Wed, 21 Sep 2016 22:08:31 +0200 Subject: [PATCH] Fixed double readme files and added a changelog --- CHANGELOG.md | 17 +++++++++++++++++ README | 13 ------------- README.md | 14 +++++++++++++- 3 files changed, 30 insertions(+), 14 deletions(-) create mode 100644 CHANGELOG.md delete mode 100644 README diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c4656c8 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,17 @@ +# Change Log +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](http://keepachangelog.com/) +and this project adheres to [Semantic Versioning](http://semver.org/). + +## [2.0.0] - 2016-09-21 +### Added +- Imported code from the lp:labcontrol repository on launchpad.net + +## [Unreleased] +### Added +### Changed +### Fixed +### Removed + +[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v2.0.0...HEAD diff --git a/README b/README deleted file mode 100644 index 0545ca0..0000000 --- a/README +++ /dev/null @@ -1,13 +0,0 @@ -# Labcontrol - -## Building and Installation - -The easiest way to build and install _Labcontrol_ is to open the `labcontrol.pro` file with _Qt Creator_ and build the project. Afterwards _Labcontrol_ can be started by running the created executable file. To build correctly _Qt5_ has to be available and must be know to _Qt Creator_. - -To work properly _Labcontrol_ requires a file named `labcontrol.conf` in `/etc/xdg/Economic\ Laboratory`. This directory must be created, the existing dummy file be copied there and afterwards be modified according to the laboratory's needs. All _z-Tree_ executables should reside in sub-directories of `/opt` following the naming scheme `zTree_X.Y.ZZ`. - -Receipt creation requires at least one receipt template in `/usr/share/labcontrol`. The name of the header file should match the pattern `NAMETHEHEADERSHALLHAVE_header.tex` to be recognized. - -## Contact - -If you have any questions or suggestions you can gladly contact me via my Github account _markuspg_. diff --git a/README.md b/README.md index 3519174..0545ca0 100644 --- a/README.md +++ b/README.md @@ -1 +1,13 @@ -# Labcontrol \ No newline at end of file +# Labcontrol + +## Building and Installation + +The easiest way to build and install _Labcontrol_ is to open the `labcontrol.pro` file with _Qt Creator_ and build the project. Afterwards _Labcontrol_ can be started by running the created executable file. To build correctly _Qt5_ has to be available and must be know to _Qt Creator_. + +To work properly _Labcontrol_ requires a file named `labcontrol.conf` in `/etc/xdg/Economic\ Laboratory`. This directory must be created, the existing dummy file be copied there and afterwards be modified according to the laboratory's needs. All _z-Tree_ executables should reside in sub-directories of `/opt` following the naming scheme `zTree_X.Y.ZZ`. + +Receipt creation requires at least one receipt template in `/usr/share/labcontrol`. The name of the header file should match the pattern `NAMETHEHEADERSHALLHAVE_header.tex` to be recognized. + +## Contact + +If you have any questions or suggestions you can gladly contact me via my Github account _markuspg_.