Changeset e3a054 in git for main.dox

Timestamp:

Jul 7, 2014, 7:28:39 PM (10 years ago)

Author:

Oleksandr Motsak <motsak@…>

Branches:

(u'spielwiese', '4a9821a93ffdc22a6696668bd4f6b8c9de3e6c5f')

Children:

8e7951cdd117df96980509cecc8e75cc174f5be0

Parents:

c238a0dd3f1aea04fdcedcf1a92ac9cd108d4b86

git-author:

Oleksandr Motsak <motsak@mathematik.uni-kl.de>2014-07-07 19:28:39+02:00

git-committer:

Oleksandr Motsak <motsak@mathematik.uni-kl.de>2014-07-09 03:22:54+02:00

Message:

Initial addition of some Wiki materials to Sources in markdown form (.md) with references

File:

• main.dox (modified) (5 diffs)

main.dox

@@ -1 +1 @@
 /*! 
-\dir
 \page main_page Introductory developers manual
 
 The Singular kernel development introduction contains:
 
-- \subpage styleguide "the C/C++ programming Style Guide",
-- \subpage bs_page "the Singular build system",
+- \subpage build_sources_page "Building Singular from Sources",
+- \subpage development_model_page "New git-supported Development Model",
+- \subpage howto_contribute_page "HowTo CONTRIBUTE to Singular development",
+- \subpage styleguide "Newer C/C++ programming style guide",
+- \subpage legacystyleguide "Legacy C programming style guide",
+- \subpage bs_page "the build system",
+- \subpage changes_in_sw_page "significant SW changes",
 - somewhat outdated Singular kernel documentation: <ftp://www.mathematik.uni-kl.de/pub/Math/Singular/doc/singular-anatomy.tgz>,
 - a short description of the Singular restructurization: <http://www.singular.uni-kl.de/gap-meeting-2012/SW.Aug.12.motsak.2.pdf> and
 - the current internal structure and dependencies can be seen at \subpage deps_page. 
   Top-level packages are:
-  - \subpage omalloc_page "Singular Memory Manager"
-  - \subpage resources_page "Resource Handling Helpers"
-  - \subpage factory_page "Factorization lib." 
-  - \subpage libpolys_page "Singular most basic data structures"
-  - \subpage kernel_page "Mathematical Algorithms"
-  - \subpage singular_page "Singular Interpreter and related"
+  - \subpage omalloc_page "Singular Memory Manager",
+  - \subpage resources_page "Resource Handling Helpers",
+  - \subpage factory_page "Factorization library",
+  - \subpage libpolys_page "Singular most basic data structures",
+  - \subpage kernel_page "Mathematical Algorithms",
+  - \subpage singular_page "Singular Interpreter and related".
 
-\dir 
-\ref main_page
+Note that Singlar may rely on some third-party \subpage external_packages_page "Packages".
 */
 
@@ -83 +86 @@
 targets in makefiles) but have to be treated specially.
 
+Short HOWTO: 
+- \subpage adding_kernel_package "Adding a sub-package to /kernel/"
+
 
 New sub-libraries may be added to the existing directories (to the
@@ -98 +104 @@
 in case of a build system chenges.
 
-See also \ref styleguide
+See also \ref styleguide and \ref legacystyleguide .
 */
 
@@ -122 +128 @@
 */
 /*!
-\dir factory
+\dir ./factory/
 \ref factory_page
 */
@@ -131 +137 @@
 
  
+/*!
+\page copying_page COPYING
+\verbinclude COPYING
+*/