Commit 2ed47a9f authored by AnonyMouse's avatar AnonyMouse
Browse files

Edit README.md

parent de746af3
Loading
Loading
Loading
Loading
Loading
+2 −4
Original line number Diff line number Diff line
@@ -11,7 +11,7 @@ for the Gitlab container registry, it isn't used here so doesn't matter what
Windows: `$env:CI_REGISTRY_IMAGE = 'total'`
Linux and Mac: `export CI_REGISTRY_IMAGE = 'total'`

If you're looking for documentation it's [here](../../wikis/home)
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).
@@ -21,9 +21,7 @@ To request a feature use [this](.gitlab/ISSUE_TEMPLATE/feature_request.md).
| Directory | Use |
|---|---|
| dockerfiles | Contains the dockerfiles for building specific docker images. |
| docs | The webpage for storing documentation on the application is built from here. |
| environment | Contains environment files for individual images. |
| exploratory | This folder contains separate exploratory work related to the project. |
| src | The location of the source files for the application. |

| File | Use |
@@ -31,5 +29,5 @@ To request a feature use [this](.gitlab/ISSUE_TEMPLATE/feature_request.md).
| .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 | A record of the changes to the application over time. |
| 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. |
 No newline at end of file