Documents :: HomeBottomXHTML1 :: CSS2

Random notes for Nemerle developers

1. The repository

All the project files, are stored in the subversion repository, at http://nemerle.org/svn. You can access them with your web browser, or a subversion client (check http://subversion.tigris.org for further information).

1.1. Fetching Nemerle

You can fetch nemerle tree using following command:

svn co http://nemerle.org/svn/nemerle/trunk nemerle

This will create nemerle/ directory (last parameter) below current working directory. You need no password to check out the repository (so-called anonymous read-only access), but you will need it to commit any changes you make.

1.2. Commit logs

You should use entire sentences when writing commit logs. A sentence starts with a capital letter and ends with a full stop. Keep this in mind, as ChangeLog files in releases are automatically generated from commit logs, and should look consistent. Don't use past forms in commit logs. For example write "Add foobar to function baz." instead of "Added foobar to function baz." (which is common practice).

2. Nemerle code style

Decision about style is up to the maintainer of given module.

2.1. Compiler

Use space before opening paren in function call and type application. Use indentation style show in the following example:

class Foo
{
  blah : bar;

  public Foo () : void
  {
    def x () {
      match (x) {
        | A => ()
        | B =>
          qux.some.long.expression (some, lengthy, args)
      }
    };
    if (cond)
      x ()
    else
      2 * x ()
  }
}

Set expand tabs option in your editor. We don't want ASCII 0x09 characters in sources.

3. Tools

There are some tools, you will probably find useful while helping us write all the software, and documentation related to the project. We try to keep this list complete, and up to date, but there still may be some pieces of software, that we forgot, as it seems natural for us to have it installed.

3.1. Required to build Nemerle Compiler

You need a .NET environment. There are several environments you can find.

You should get nemerle compiler in the tarball. If you experience any problems with it, or have downloaded sources from subversion repository, use the one from http://nemerle.org/download/ncc-boot.exe.

3.2. Required to generate complete documentation

3.3. Required to create tarball with Nemerle distribution

3.4. Other tools

These are not prerequisites to do any task, but may be very helpful, and we ask you to use them, as they minimize amount of mistakes.

4. Documentation XML


Documents :: HomeTopXHTML1 :: CSS2