source: apps/sam/csharp/README @ 868e5e9

Last change on this file since 868e5e9 was 5018e56, checked in by zzz <zzz@…>, 16 years ago

oops, moving README and sam-sharp.build out of the source directory

  • Property mode set to 100644
File size: 1.9 KB
Line 
1sam-sharp
2
3
4DESCRIPTION
5
6  sam-sharp is a .NET SAM client library for I2P written in C#. It aims to be
7  compatible with platforms that implement .NET's base class library API (such
8  as Mono and DotGNU Portable.NET) and to be usable from all languages
9  conforming to the ECMA-standardized Common Language Infrastructure, including
10  C# and VB.NET.
11
12
13MINIMUM REQUIREMENTS
14
15  * Mono and mcs 1.0 or higher (Linux, Mac OS X, Windows)
16
17         - or -
18
19    MS .NET Framework SDK 1.0 or higher (Windows)
20
21         - or -
22
23    DotGNU Portable .NET, latest version recommended (*BSD, AIX, Cygwin, Linux,
24    Mac OS X, MinGW, Solaris)
25
26
27OPTIONAL REQUIREMENTS
28
29  * NAnt 0.85 or higher is needed to use sam-sharp.build. Sorry, NAnt does not
30    yet support Portable.NET.
31
32  * NUnit 2.2.1 or later is needed to run the (soon-to-be-added) unit tests. If
33    you have the Mono mcs package installed then you already have NUnit.
34
35
36DOCUMENTATION
37
38  Pre-generated docs will be submitted to CVS soon. In the meantime you may
39  generate standalone documentation from the embedded XML doc comments by
40  issuing the following commands from sam-sharp's src/ directory:
41
42    Mono:
43
44      mkdir ../doc
45      mcs -doc:../doc/sam-sharp_doc.xml *.cs
46
47    MS .NET:
48
49      mkdir ../doc
50      csc /doc:../doc/sam-sharp_doc.xml *.cs
51
52    DotGNU Portable.NET:
53
54      mkdir ../doc
55      csdoc -o ../doc/sam-sharp_doc.xml *.cs
56
57  The resulting XML doc can be converted to HTML using either Visual Studio .NET
58  (Tools > Build Comment Web Pages) or Portable.NET's csdoc2html tool:
59
60    csdoc2html -o ../doc ../doc/sam-sharp_doc.xml
61
62
63ACKNOWLEDGMENTS
64
65  sam-sharp is a port of jrandom's public domain Java SAM client library.
66
67
68LICENSE
69
70  This work is released into the public domain.
71
72
73AUTHORS
74
75  jrandom (original Java SAM client library)
76  smeghead (C# port of the Java SAM client library)
77
78
79MAINTAINERS
80
81  smeghead <smeghead@i2pmail.org> <smeghead@mail.i2p>
82
83
84$Id: README,v 1.1 2005/01/24 17:42:05 smeghead Exp $
Note: See TracBrowser for help on using the repository browser.