Frontpage for documentation

diff --git a/Doxyfile.in b/Doxyfile.in
index 13a2e33b660a587b8710f089bbd8096e860f11f4..89a7ae6e0b97bc8415cea3d66139c6ad90c0d73e 100644 (file)
--- a/Doxyfile.in
+++ b/Doxyfile.in
@@ -654,7 +654,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = src
+INPUT                  = src README.md
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -779,7 +779,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE =
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # configuration options related to source browsing

diff --git a/README b/README
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..e2ed03e1774f8752a4e14827d522e70f176bc9c4 100644 (file)
--- a/README
+++ b/README
@@ -0,0 +1,50 @@
+VLP
+===
+
+VLP is an abbreviation of Virtual Loglan Processor.
+
+What is Loglan?
+---------------
+
+Loglan (Loglan-82) is a programming Language designed and realized in Institute
+of Computer Science in University of Warsaw. It is universal language, whose
+fundamental characteristic is rich modular structure. Main concepts of language
+are classes and modules prefixing. These were introduced in Simula-67, and
+had a signifant effect on programming metodology and understanding of modern
+language modules concept. This influence is visible in many programming
+languages such as: Modula, Smalltalk or (to a certain degree) Ada. Module
+prefixing in Loglan is more general mechanism than it was in Simula-67. It
+allows reaching many different goals, whose practital importance is enormous
+(...) [1]
+
+Whom created VLP?
+-----------------
+
+Original author of VLP was: dr Oskar Świda.
+
+Where could I find out more about Loglan?
+-----------------------------------------
+
+- [Official page][official_page]
+- [Official project page][project]
+
+What is a difference between official project and this one?
+-----------------------------------------------------------
+
+This is a fork Qt3 based VLP. Last entry of original code is dated: 15 Jan 1998.
+Qt3 was released on: 16 October 2001, so precise date is not known by me.
+
+Fork contains VLP, Loglan compilator and interpreter. It is carried
+independently by me (Rafał Długołęcki).
+
+Main targets of this fork are:
+1.  Document everything
+2.  Rewrite compilator to use grammar file, which will be parsed by e.g. Bison
+3.  Separate layout code from the logic
+
+Bibliography
+------------
+
+[1]:    "Szałas, A and Warpechowska, J (1991). Loglan"
+[official_page]:    http://lem12.uksw.edu.pl/
+[project]:          http://sourceforge.net/projects/loglan82

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..e2ed03e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,50 @@
+VLP
+===
+
+VLP is an abbreviation of Virtual Loglan Processor.
+
+What is Loglan?
+---------------
+
+Loglan (Loglan-82) is a programming Language designed and realized in Institute
+of Computer Science in University of Warsaw. It is universal language, whose
+fundamental characteristic is rich modular structure. Main concepts of language
+are classes and modules prefixing. These were introduced in Simula-67, and
+had a signifant effect on programming metodology and understanding of modern
+language modules concept. This influence is visible in many programming
+languages such as: Modula, Smalltalk or (to a certain degree) Ada. Module
+prefixing in Loglan is more general mechanism than it was in Simula-67. It
+allows reaching many different goals, whose practital importance is enormous
+(...) [1]
+
+Whom created VLP?
+-----------------
+
+Original author of VLP was: dr Oskar Świda.
+
+Where could I find out more about Loglan?
+-----------------------------------------
+
+- [Official page][official_page]
+- [Official project page][project]
+
+What is a difference between official project and this one?
+-----------------------------------------------------------
+
+This is a fork Qt3 based VLP. Last entry of original code is dated: 15 Jan 1998.
+Qt3 was released on: 16 October 2001, so precise date is not known by me.
+
+Fork contains VLP, Loglan compilator and interpreter. It is carried
+independently by me (Rafał Długołęcki).
+
+Main targets of this fork are:
+1.  Document everything
+2.  Rewrite compilator to use grammar file, which will be parsed by e.g. Bison
+3.  Separate layout code from the logic
+
+Bibliography
+------------
+
+[1]:    "Szałas, A and Warpechowska, J (1991). Loglan"
+[official_page]:    http://lem12.uksw.edu.pl/
+[project]:          http://sourceforge.net/projects/loglan82

diff --git a/configure.ac b/configure.ac
index 757095cbaf25dd7b7a962ceb630c2712948c3410..dcfdebf9d284ebe120507dcd3369e1ebe1d2cfb5 100644 (file)
--- a/configure.ac
+++ b/configure.ac
@@ -1,4 +1,4 @@
-AC_INIT([Virtual Loglan Processor], [3.4-b1], [bugz@dlugolecki.net.pl], [vlp], [http://dlugolecki.net.pl/software/vlp/])
+AC_INIT([VLP], [3.4-b1], [bugz@dlugolecki.net.pl], [vlp], [http://dlugolecki.net.pl/software/vlp/])
 AC_PREREQ([2.59])
 AM_INIT_AUTOMAKE([1.10 no-define])
 AC_CONFIG_HEADERS([config.h])