ncc/tests/example_project/README.md

# Example Project

This is a simple library that provides very basic functionality,
this project is a means to test the compiler capabilities of NCC


### Generating a project configuration file.

You can generate a project configuration file using the NCC
command-line interface, you should run the command in the
root directory of your project rather than the source directory.

The argument `src` allows you to specify the source directory
which is required, otherwise NCC will assume the src directory is the current working directory.

```shell
$ ls
README.md  src

$ ncc project create --src="src/ExampleLibrary" --package="com.example.library" --name="ExampleLibrary"
Project successfully created

$ ls
ncc  project.json  README.md  src
```

Upon creating the project, you will see a directory named `ncc`
and a file named `project.json`, the `ncc` directory will simply
contain extra information about the project, the file `project.json`
contains information about the project itself, you can modify
and change the contents of the project accordingly

This process only needs to be done once, any additional changes
can be done manually by editing project.json

Once project.json is created, the project can be compiled using NCC


### Compiling the project