Edit README.md

# Gitlab component template

<!--

Update this readme with your component details. Replace content in `< >` with your project information.

For more information:

- How to create a CI/CD component: https://docs.gitlab.com/ee/ci/components/#write-a-component

- How to write a clear README.md file: https://docs.gitlab.com/ee/ci/components/#write-a-clear-readmemd

- CI/CD Component security best practices: https://docs.gitlab.com/ee/ci/components/#cicd-component-security-best-practices

-->

<!-- Uncomment and update the following link to display a release badge: https://docs.gitlab.com/ee/user/project/badges.html#latest-release-badges -->

<!-- [![Latest Release](https://gitlab.com/<your project path>/-/badges/release.svg)](https://gitlab.com/<your project path>/-/releases) -->

## Components

### `<Component-name>`

Use this component to `<component-description>`.

To add this component to your CI/CD pipeline, add the following include entry to your

project's CI/CD configuration:

```yaml

include:

  - component: https://gitlab.com/<your project path>/<name of your template>@<tag>

```

Where `<tag>` is the release tag you want to use ([releases list](https://gitlab.com/<your-project-path>/-/releases)).

## Inputs

The template contains some optional [inputs](https://docs.gitlab.com/ee/ci/yaml/inputs.html):

<!-- Add or update rows if you change the inputs in the template -->

| Input      | Default value    | Description |

|------------|------------------|-------------|

| `job_name` | `job-template`   | The job name. |

| `image`    | `busybox:latest` | The container image to use to run the job. |

| `stage`    | `test`           | The stage name for the job. |

## Documentation

This project includes a MVC structure to help you get started with [Gitlab CI/CD components](https://docs.gitlab.com/ee/ci/components/).

The template provides the basic file structure to create your own single component.

This project should be public, or one of the jobs in the project's pipeline won't work.

## Licence

The licence can be changed. By default this project has the [MIT Licence](./LICENCE).

<!-- You should update the year and name in the license file. -->

# PorkBrainz

An esoteric language interpreter for the PorkBrainz language. 

Based on Brainfuck, with Hamming Code compliance checking. 

This project mostly serves as a learning opportunity for language development.

To build the containers locally you will need to set the environment variable

for the Gitlab container registry, it isn't used here so doesn't matter what

Windows: `$env:CI_REGISTRY_IMAGE = 'porkbrainz'`

Linux and Mac: `export CI_REGISTRY_IMAGE = 'porkbrainz'`

If you're looking for documentation it's [here](../../wikis/home).

The licence for this project is [here](LICENSE).

If you want to contribute, read [this](CONTRIBUTING.md).

To merge your commits use [this](PULL_REQUEST_TEMPLATE.md).

To report a bug use [this](.gitlab/ISSUE_TEMPLATE/bug_report.md).

To request a feature use [this](.gitlab/ISSUE_TEMPLATE/feature_request.md).

| Directory | Use |

|---|---|

| .gitlab | Contains GitLab related files. |

| dockerfiles | Contains the dockerfiles for building specific docker images. |

| environment | Contains environment files for individual images. |

| src | The location of the source files for the application. |

| templates | Contains components for the GitLab CI. |

| File | Use |

|---|---|

| .env | The global environment file for managing the compose build. |

| .gitignore | For managing which files you don't want merging, i.e. local environment files. |

| .gitlab-ci.yml | An automation CI/CD file, set to be integrated with github workflows once moved |

| CHANGELOG.md | A record of the changes to the application over time. |

| test.yml and prod.yml | The docker-compose build instructions for the repo images. |