Recent changes to Home

Home modified by Marek Trtík

Marek Trtík — Thu, 05 Mar 2015 20:41:54 -0000

--- v52
+++ v53
@@ -69,24 +69,35 @@

 In case of project files of MS Visual Studio simply start the studio and open the solution file located in the build directory.

-In all cases, when building finishes all built binaries will be located in the subdirectory:
+In all cases, when building finishes, all resulting binaries can be found in the subdirectory *dist* of the *bugst_repo* directory.

-*bugst_repo/dist*
+*3. Building Bugst in QT Creator*
+
+This is an alternative building process to the one described above. This process is better for development.
+
+a. Start QT Creator IDE.
+
+b. Use *Open File or Project* menu option to open the file *bugst_repo/CMakeLists.txt* in the IDE.
+
+c. Push *Projects* button on the left horizontal bar in order to swicht to the tab with project settings. There in *Edit build configuration:* clone the default configuration and choose a proper name for it - according to the kind of build, i.e. Debug, Release, or RelWithDebInfo.
+
+d. Specify build directory, e.g. *build_repo/build*.
+
+e. Specify CMake arguments:
+  - *-DCMAKE_BUILD_TYPE=<build-type>* Possible values are Debug, Release, RelWithDebInfo.
+  - *-DBOOST_ROOT=<path-to-boost>*
+  - *-DZ3_ROOT=<path-to-z3>*
+  - *-DLLVM_ROOT=<path-to-llvm>*
+  - *-DHREDIS_ROOT=<path-to-hredis>*
+  - *-DANTLR_ROOT=<path-to-antlr>*
+
+Of course, not all variables are necessary - some dependances are optional.

+**Using Bugst**

-2. Open the solution file *bugst/bugst.sln* in Visual Studio.
+TODO!

-3. Update references to dependent software, like Boost, LLVM, and Z3, in properties of Bugst's libraries or tools you want to build. (TODO: add more details here!!)
-
-4. In Visual Studio use the menu option '*Build/Butch Build...*' to select libraries, tool, or tests which you want to build. Then click at *Build* button there. Note that you can choose *Debug* and/or *Release* versions of libraries, tool, or tests.
-
-During building process two directories are created:
-
-- *bugst/build* It contains object and other intermediate files produced during the build.
-- *bugst/dist* It contains resulting library and executable files of libraries, tools, or tests selected into the build.
-
-Some tools and tests require data files. These data files have to be copied into *dist* directory before running the tools or tests. This can be done by running a script file *bugst/data/install.bat*.

 Stucture of Bugst
 -----------------

Home modified by Marek Trtík

Marek Trtík — Thu, 05 Mar 2015 20:22:46 -0000

--- v51
+++ v52
@@ -50,7 +50,7 @@

 c. Into the edit box bellow it type a path where build scripts will be stored. Typically, you specify a subdirectory *build* of the *bugst_repo* directory. If you do not created this directory yet, the CMake will later ask you whether it should create the directory for you or not. Then choose 'yes'.

-d. Push the button 'Configure'. When the CMake finishes its work a list box above the button is filled in with several variables. Check values of the variables and fix wrong ones. The following variables are epsecially important:
+d. Push the button *Configure*. After that CMake allows you to target choose build system (and perhaps also compliler). On Linux platform we recomend Unix Makefiles and GCC and on Windows we recomend both project files and compiler of MS Visual Studio. When the CMake finishes its work a list box above the button is filled in with several variables. Check values of the variables and fix wrong ones. The following variables are epsecially important:

   - *CMAKE_BUILD_TYPE* A kind of build you are interested in. Available values are: Debug, Release, RelWithDebInfo.
   - *BOOST_ROOT* A path to the installation directory of Boost libraries.
@@ -59,7 +59,20 @@
   - *HREDIS_ROOT* A path to the installation directory of HREDIS client.
   - *ANTLR_ROOT* A path to the installation directory of ANTLR parser generator.

-aa
+e. Keep pushing the button *Configure* until no line in the list box above it is red. It usually requires two pushes. In case some lines remain red, then you have to fix their values as they are very likely wrong.
+
+f. Once no line in the list box is red, then push the button *Generate*. Now you can close CMake GUI aplication, since all build scripts were generated into your build directory, i.e. typically into *build_repo/build*.
+
+g. Open terminal and navigate into the build directory, e.g. into *build_repo/build*. Then run the build scripts. This step depends on what target build system you have chosen. In case of Unix Makefiles type:
+
+*make install*
+
+In case of project files of MS Visual Studio simply start the studio and open the solution file located in the build directory.
+
+In all cases, when building finishes all built binaries will be located in the subdirectory:
+
+*bugst_repo/dist*
+

 2. Open the solution file *bugst/bugst.sln* in Visual Studio.

Home modified by Marek Trtík

Marek Trtík — Thu, 05 Mar 2015 20:06:50 -0000

--- v50
+++ v51
@@ -39,7 +39,7 @@

 *git clone git://git.code.sf.net/p/bugst/src .*

-Do not forget the character '.' at the end of the command.
+Do not forget to include the space and the character '.' at the end of the command.

 *2. Building Bugst using CMake GUI*
@@ -52,7 +52,14 @@

 d. Push the button 'Configure'. When the CMake finishes its work a list box above the button is filled in with several variables. Check values of the variables and fix wrong ones. The following variables are epsecially important:

-  - *CMAKE_BUILD_TYPE* It allows you to specify which build type you are interested in. Available values are: Debug, Release, RelWithDebInfo.
+  - *CMAKE_BUILD_TYPE* A kind of build you are interested in. Available values are: Debug, Release, RelWithDebInfo.
+  - *BOOST_ROOT* A path to the installation directory of Boost libraries.
+  - *Z3_ROOT* A path to the installation directory of Z3 solver.
+  - *LLVM_ROOT* A path to the installation directory of LLVM. Note that another variable *LLVM_DIR* is not important. Do not modify it.
+  - *HREDIS_ROOT* A path to the installation directory of HREDIS client.
+  - *ANTLR_ROOT* A path to the installation directory of ANTLR parser generator.
+
+aa

 2. Open the solution file *bugst/bugst.sln* in Visual Studio.

Home modified by Marek Trtík

Marek Trtík — Thu, 05 Mar 2015 20:01:15 -0000

--- v49
+++ v50
@@ -48,7 +48,11 @@

 b. In the edit-box in the very top type the path to your *bugst_repo* directory.

-c. Into the edit box bellow it type a path where the generated buid scripts and other files generated during the build will be stored. Typically, you specify: 
+c. Into the edit box bellow it type a path where build scripts will be stored. Typically, you specify a subdirectory *build* of the *bugst_repo* directory. If you do not created this directory yet, the CMake will later ask you whether it should create the directory for you or not. Then choose 'yes'.
+
+d. Push the button 'Configure'. When the CMake finishes its work a list box above the button is filled in with several variables. Check values of the variables and fix wrong ones. The following variables are epsecially important:
+
+  - *CMAKE_BUILD_TYPE* It allows you to specify which build type you are interested in. Available values are: Debug, Release, RelWithDebInfo.

 2. Open the solution file *bugst/bugst.sln* in Visual Studio.

Home modified by Marek Trtík

Marek Trtík — Thu, 05 Mar 2015 19:49:12 -0000

--- v48
+++ v49
@@ -37,11 +37,19 @@

 Create a new empty directory, say *bugst_repo*, somewhere on the disc. Open your terminal and navigate into that directory. Then type the following command:

-*'git clone git://git.code.sf.net/p/bugst/src .'*
+*git clone git://git.code.sf.net/p/bugst/src .*

 Do not forget the character '.' at the end of the command.

-1. Clone Bugst's repository *git://git.code.sf.net/p/bugst/src* at SourceForge using Git into *bugst* directory in hard drive of your computer.
+
+*2. Building Bugst using CMake GUI*
+
+a. Start the CMake GUI application.
+
+b. In the edit-box in the very top type the path to your *bugst_repo* directory.
+
+c. Into the edit box bellow it type a path where the generated buid scripts and other files generated during the build will be stored. Typically, you specify: 
+

 2. Open the solution file *bugst/bugst.sln* in Visual Studio.

Home modified by Marek Trtík

Marek Trtík — Thu, 05 Mar 2015 18:42:10 -0000

--- v47
+++ v48
@@ -32,6 +32,14 @@
 **Building Bugst**

 Here we assume that all required software (see the previous section) is installed on user's computer. 
+
+*1. Clone Bugst's repository*
+
+Create a new empty directory, say *bugst_repo*, somewhere on the disc. Open your terminal and navigate into that directory. Then type the following command:
+
+*'git clone git://git.code.sf.net/p/bugst/src .'*
+
+Do not forget the character '.' at the end of the command.

 1. Clone Bugst's repository *git://git.code.sf.net/p/bugst/src* at SourceForge using Git into *bugst* directory in hard drive of your computer.

Home modified by Marek Trtík

Marek Trtík — Thu, 05 Mar 2015 18:30:51 -0000

--- v46
+++ v47
@@ -10,7 +10,7 @@

 **Availability**

-Bugst is completely free software project. It means that we do not put any restrictions to use of any possible kind of any content downloaded from Bugst's repository. In the same time we take no responsibily in any consequences caused by the use of the downoaded content. We emphasise that one can freely read, download, modify, share, distribute, or sell any part of Bugst and freely include any original or modified part of Bugst to any software project.
+Bugst is completely free software project. It means that we put no restrictions to usage of a content downloaded from Bugst's repository. In the same time we take no responsibily in consequences caused by the usage of the downloaded content. We emphasise that one can freely read, download, modify, share, distribute, or sell any part of Bugst and freely include any original or modified part of Bugst to any software project.

 **Build Environment and Software Dependences**

@@ -30,6 +30,8 @@
 - Optional: [QT Creator](http://qt-project.org/wiki/Category:Tools::QtCreator) is a recommended development IDE on both platforms (Linux and MS WIndows). It is not mandatory though. In case you decide to use it, make sure that it is equiped with CMake plugin.

 **Building Bugst**
+
+Here we assume that all required software (see the previous section) is installed on user's computer. 

 1. Clone Bugst's repository *git://git.code.sf.net/p/bugst/src* at SourceForge using Git into *bugst* directory in hard drive of your computer.

Home modified by Marek Trtík

Marek Trtík — Wed, 04 Mar 2015 19:40:30 -0000

--- v45
+++ v46
@@ -17,13 +17,13 @@
 Bugst is supposed to be built on a computer with:

 - Linux or MS Windows operating system. The main development platforms are [Ubuntu](http://www.ubuntu.com/) and [Linux Mint](http://www.linuxmint.com/).
-- [Git](http://git-scm.com/) This distributed version control system is required to download Bugst from the repository at SourceForge. We recommend to install also git client [SmartGit](http://www.syntevo.com/smartgithg/).
+- [Git](http://git-scm.com/) distributed version control system. It is required to download Bugst from the repository at SourceForge. We recommend to install also git client [SmartGit](http://www.syntevo.com/smartgithg/).
 - [CMake](http://www.cmake.org/) build system. A minimal supported version is 2.8.
 - A C++ compiler supproting the ISO standard from 12 August 2011 (i.e. C++11). A recommended compiler on Linux platform is [GCC](https://gcc.gnu.org/) version 4.8.2 or newer. On MS Windows the recommended compiler is the one of [MS Visual Studio 2012](https://www.visualstudio.com/) or newer. Note though that .vcproj and .sln files appearing in the repository of Bugst are obsolete. Use CMake to generate project files.
 - [Python](https://www.python.org/) 2.7 or newer.
 - [boost C++ Libraries](http://www.boost.org/) A minimal supported version is 1.57. Boost is the common dependece for almost all libraries in Bugst. A user should build at least the following Boost's libraries: system, thread, chrono, filesystem, log, log_setup, and program_options.
-- [Z3](http://z3.codeplex.com/) This theorem proves is required for building Bugst's library [Fol](https://sourceforge.net/p/bugst/wiki/Fol/). Source code and built libraries are required.
-- Optional: [The LLVM Compiler Infrastructure](http://llvm.org/) A minimal supported version is 3.5. It is required for building Bugst's library [LlvmUtl](https://sourceforge.net/p/bugst/wiki/LlvmUtl/) and tools [llvm2celllvm](https://sourceforge.net/p/bugst/wiki/llvm2celllvm/) and [celllvm2lonka](https://sourceforge.net/p/bugst/wiki/celllvm2lonka/). We highly recommend to install this package, since LLVM is a default front-end for Bugst. Without it you will have to write Lonka files (a program representation in Bugst) by hand, which is VERY tedious work.
+- [Z3](http://z3.codeplex.com/) theorem prover. It is required for building Bugst's library [Fol](https://sourceforge.net/p/bugst/wiki/Fol/). Source code and built libraries are required. The tool's binary is not enough.
+- Optional: [The LLVM Compiler Infrastructure](http://llvm.org/) A minimal supported version is 3.5. It is required for building Bugst's library [LlvmUtl](https://sourceforge.net/p/bugst/wiki/LlvmUtl/) and tools [llvm2celllvm](https://sourceforge.net/p/bugst/wiki/llvm2celllvm/) and [celllvm2lonka](https://sourceforge.net/p/bugst/wiki/celllvm2lonka/). Source code and libraries are required. We highly recommend to install this package, since LLVM is a default front-end for Bugst. Without it you will have to write Lonka files (a program representation in Bugst) by hand, which is VERY tedious work.
 - Optional: [CLANG](http://clang.llvm.org/) C front-end for LLVM. Only its binary is required, i.e. no source code, no libraries. Bugst supports automatic translation from C programs to Lonka, using CLANG and LLVM tools. Therefore, we highly recommend install both CLANG and LLVM optional packages.
 - Optional: [Redis](http://redis.io/) advanced key-value cache and store and its client [HIREDIS](https://github.com/redis/hiredis). These packages enable portfolio approach for calls to SMT solvers, see branch portfolio_approach.
 - Optional: [ANTLR](http://www.antlr.org/) parser generator. It is required only for the tool atomic-C of bugst.

Home modified by Marek Trtík

Marek Trtík — Wed, 04 Mar 2015 19:35:42 -0000

--- v44
+++ v45
@@ -22,9 +22,9 @@
 - A C++ compiler supproting the ISO standard from 12 August 2011 (i.e. C++11). A recommended compiler on Linux platform is [GCC](https://gcc.gnu.org/) version 4.8.2 or newer. On MS Windows the recommended compiler is the one of [MS Visual Studio 2012](https://www.visualstudio.com/) or newer. Note though that .vcproj and .sln files appearing in the repository of Bugst are obsolete. Use CMake to generate project files.
 - [Python](https://www.python.org/) 2.7 or newer.
 - [boost C++ Libraries](http://www.boost.org/) A minimal supported version is 1.57. Boost is the common dependece for almost all libraries in Bugst. A user should build at least the following Boost's libraries: system, thread, chrono, filesystem, log, log_setup, and program_options.
-- [Z3](http://z3.codeplex.com/) This theorem proves is required for building Bugst's library [Fol](https://sourceforge.net/p/bugst/wiki/Fol/). Note that several other libraries of Bugst are dependent on the Fol library.
+- [Z3](http://z3.codeplex.com/) This theorem proves is required for building Bugst's library [Fol](https://sourceforge.net/p/bugst/wiki/Fol/). Source code and built libraries are required.
 - Optional: [The LLVM Compiler Infrastructure](http://llvm.org/) A minimal supported version is 3.5. It is required for building Bugst's library [LlvmUtl](https://sourceforge.net/p/bugst/wiki/LlvmUtl/) and tools [llvm2celllvm](https://sourceforge.net/p/bugst/wiki/llvm2celllvm/) and [celllvm2lonka](https://sourceforge.net/p/bugst/wiki/celllvm2lonka/). We highly recommend to install this package, since LLVM is a default front-end for Bugst. Without it you will have to write Lonka files (a program representation in Bugst) by hand, which is VERY tedious work.
-- Optional: [CLANG](http://clang.llvm.org/) C front-end for LLVM. Bugst supports automatic translation from C programs to Lonka, using CLANG and LLVM tools. Therefore, we highly recommend install both CLANG and LLVM optional packages.
+- Optional: [CLANG](http://clang.llvm.org/) C front-end for LLVM. Only its binary is required, i.e. no source code, no libraries. Bugst supports automatic translation from C programs to Lonka, using CLANG and LLVM tools. Therefore, we highly recommend install both CLANG and LLVM optional packages.
 - Optional: [Redis](http://redis.io/) advanced key-value cache and store and its client [HIREDIS](https://github.com/redis/hiredis). These packages enable portfolio approach for calls to SMT solvers, see branch portfolio_approach.
 - Optional: [ANTLR](http://www.antlr.org/) parser generator. It is required only for the tool atomic-C of bugst.
 - Optional: [QT Creator](http://qt-project.org/wiki/Category:Tools::QtCreator) is a recommended development IDE on both platforms (Linux and MS WIndows). It is not mandatory though. In case you decide to use it, make sure that it is equiped with CMake plugin.

Home modified by Marek Trtík

Marek Trtík — Wed, 04 Mar 2015 19:31:35 -0000

--- v43
+++ v44
@@ -22,11 +22,12 @@
 - A C++ compiler supproting the ISO standard from 12 August 2011 (i.e. C++11). A recommended compiler on Linux platform is [GCC](https://gcc.gnu.org/) version 4.8.2 or newer. On MS Windows the recommended compiler is the one of [MS Visual Studio 2012](https://www.visualstudio.com/) or newer. Note though that .vcproj and .sln files appearing in the repository of Bugst are obsolete. Use CMake to generate project files.
 - [Python](https://www.python.org/) 2.7 or newer.
 - [boost C++ Libraries](http://www.boost.org/) A minimal supported version is 1.57. Boost is the common dependece for almost all libraries in Bugst. A user should build at least the following Boost's libraries: system, thread, chrono, filesystem, log, log_setup, and program_options.
-- [The LLVM Compiler Infrastructure](http://llvm.org/) A minimal supported version is 3.5. It is required for building Bugst's library [LlvmUtl](https://sourceforge.net/p/bugst/wiki/LlvmUtl/) and tools [llvm2celllvm](https://sourceforge.net/p/bugst/wiki/llvm2celllvm/) and [celllvm2lonka](https://sourceforge.net/p/bugst/wiki/celllvm2lonka/). We further recommend a user to also install the [CLANG](http://clang.llvm.org/) C front-end for LLVM.
 - [Z3](http://z3.codeplex.com/) This theorem proves is required for building Bugst's library [Fol](https://sourceforge.net/p/bugst/wiki/Fol/). Note that several other libraries of Bugst are dependent on the Fol library.
-- Optional: [QT Creator](http://qt-project.org/wiki/Category:Tools::QtCreator) is a recommended development IDE on both platforms (Linux and MS WIndows). It is not mandatory though. In case you decide to use it, make sure that it is equiped with CMake plugin.
+- Optional: [The LLVM Compiler Infrastructure](http://llvm.org/) A minimal supported version is 3.5. It is required for building Bugst's library [LlvmUtl](https://sourceforge.net/p/bugst/wiki/LlvmUtl/) and tools [llvm2celllvm](https://sourceforge.net/p/bugst/wiki/llvm2celllvm/) and [celllvm2lonka](https://sourceforge.net/p/bugst/wiki/celllvm2lonka/). We highly recommend to install this package, since LLVM is a default front-end for Bugst. Without it you will have to write Lonka files (a program representation in Bugst) by hand, which is VERY tedious work.
+- Optional: [CLANG](http://clang.llvm.org/) C front-end for LLVM. Bugst supports automatic translation from C programs to Lonka, using CLANG and LLVM tools. Therefore, we highly recommend install both CLANG and LLVM optional packages.
 - Optional: [Redis](http://redis.io/) advanced key-value cache and store and its client [HIREDIS](https://github.com/redis/hiredis). These packages enable portfolio approach for calls to SMT solvers, see branch portfolio_approach.
 - Optional: [ANTLR](http://www.antlr.org/) parser generator. It is required only for the tool atomic-C of bugst.
+- Optional: [QT Creator](http://qt-project.org/wiki/Category:Tools::QtCreator) is a recommended development IDE on both platforms (Linux and MS WIndows). It is not mandatory though. In case you decide to use it, make sure that it is equiped with CMake plugin.

 **Building Bugst**