README 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130
  1. This contains code written in C# of Mono, it contains:
  2. * Compilers written in C#
  3. * Class Libraries.
  4. * Regression Test Suites
  5. To install this source code, look at the INSTALL file in the `mono'
  6. package module which drives the compilation of this directory.
  7. * Layout
  8. ========
  9. build/
  10. Rules, configuration and makefile components to build
  11. this module.
  12. class/
  13. The class libraries.
  14. errors/
  15. Sample programs that should generate errors by the C# compiler.
  16. gmcs/
  17. The Mono C# compiler with Generics support. This will
  18. become the default in Mono 2.0.
  19. jay/
  20. Yacc-based parser generator.
  21. mcs/
  22. The Mono C# compiler (1.0 + 2.0 minus generics).
  23. tests/
  24. Regression test suite for the C# compiler
  25. docs/
  26. Some notes on the compiler and the class libraries.
  27. nant/
  28. A copy of nant source code, used during the build process
  29. on Windows.
  30. tools/
  31. Various small development tools: CorCompare used to compare
  32. two assemblies for differences in the API; TypeReflector is
  33. a tool used to introspect types from assemblies from the
  34. command line; MonoStyle helps you keep your code indendented
  35. with the Mono programming style.
  36. * Building Individual Directories
  37. =================================
  38. You can build individual components in the hierarchy by running the command
  39. "make", and to install it use "make install".
  40. If you need to build a given component on the 2.x profile, you must use
  41. the following command:
  42. make PROFILE=net_2_0
  43. And to install:
  44. make PROFILE=net_2_0 install
  45. * Running Unit tests
  46. ====================
  47. You can run unit tests in individual components by running the command
  48. "make run-test". If you want to run tests for a different profile (say
  49. 'net_2_0')
  50. make run-test PROFILE=net_2_0
  51. If you want to only run the tests in a single fixture (say
  52. 'MonoTests.System.TypeTest'), you can use
  53. make run-test TEST_HARNESS_FLAGS=/fixture:MonoTests.System.TypeTest
  54. * Acknowledgements
  55. ==================
  56. Thanks a lot to Sergey Chaban for his help during the development of
  57. the C# compiler.
  58. * LICENSE
  59. =========
  60. The mcs C# compiler and monoresgen are licensed to you under the GPL, version 2.
  61. The complete text of the GPL is in the 'COPYING' file.
  62. Copyright (C) 2001-2002 Ximian, Inc.
  63. This program is free software; you can redistribute it and/or modify
  64. it under the terms of version 2 of the GNU General Public License as
  65. published by the Free Software Foundation.
  66. This program is distributed in the hope that it will be useful,
  67. but WITHOUT ANY WARRANTY; without even the implied warranty of
  68. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  69. GNU General Public License for more details.
  70. You should have received a copy of the GNU General Public License
  71. along with this program; if not, write to the Free Software
  72. Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  73. The class libraries are licensed according to the following license:
  74. Copyright (C) 2001-2002 Ximian, Inc.
  75. Permission is hereby granted, free of charge, to any person obtaining a
  76. copy of this software and associated documentation files (the "Software"),
  77. to deal in the Software without restriction, including without limitation
  78. the rights to use, copy, modify, merge, publish, distribute, sublicense,
  79. and/or sell copies of the Software, and to permit persons to whom the
  80. Software is furnished to do so, subject to the following conditions:
  81. The above copyright notice and this permission notice shall be included
  82. in all copies or substantial portions of the Software.
  83. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  84. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  85. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  86. THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  87. OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  88. ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  89. OTHER DEALINGS IN THE SOFTWARE.