Adding READMEs to all directories #584
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ## 'ISSUE_TEMPLATE' Directory Contents | ||
|
|
||
| ### Files | ||
|
|
||
| bug_report.yml | ||
|
|
||
| feature_request.yaml | ||
|
|
||
| voxl.yml | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ## 'workflows' Directory Contents | ||
|
|
||
| ### Files | ||
|
|
||
| main.yml | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| ## 'PIXL/bin' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Subdirectories with links to the relevant README </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| [linters](./linters/README.md) | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **User docs** | | ||
| | :--- | | ||
| README.md | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,16 @@ | ||||||
| A directory that contains the files used for linting. | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| ## 'PIXL/bin/linters' Directory Contents | ||||||
|
|
||||||
| <details> | ||||||
| <summary> | ||||||
| <h3> Files </h3> | ||||||
|
|
||||||
| </summary> | ||||||
|
|
||||||
| | **Code** | **User docs** | | ||||||
| | :--- | :--- | | ||||||
| | check_headers_exist.sh | README.md | | ||||||
|
|
||||||
| </details> | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| This directory contains the source files for the PIXL commands line interface. | ||
|
|
||
| ## 'PIXL/cli/src' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Subdirectories with links to the relevant README </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| [pixl_cli](./pixl_cli/README.md) | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **User docs** | | ||
| | :--- | | ||
| README.md | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| This directory contains the files necessary to create a command line instance of PIXL. | ||
|
|
||
| ## 'PIXL/cli/src/pixl_cli' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Code** | **User docs** | | ||
| | :--- | :--- | | ||
| | main.py | README.md | | ||
| | _config.py | | | ||
| | _database.py | | | ||
| | _docker_commands.py | | | ||
| | _io.py | | | ||
| | _message_processing.py | | | ||
| | __init__.py | | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,33 @@ | ||
| # PIXL cli tests | ||
|
|
||
| This directory contains the code for the tests of the PIXL command line interface. | ||
|
|
||
|
|
||
|
|
||
| In order to remove the db container and associated data after the tests have been run use the following command: | ||
|
|
||
| ```bash | ||
| docker container rm pixl-test-db -v -f | ||
| ``` | ||
|
|
||
| ## 'PIXL/cli/tests' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Code** | **User docs** | | ||
| | :--- | :--- | | ||
| | conftest.py | README.md | | ||
| | test_check_env.py | | | ||
| | test_database.py | | | ||
| | test_docker_commands.py | | | ||
| | test_io.py | | | ||
| | test_messages_from_files.py | | | ||
| | test_message_processing.py | | | ||
| | test_populate.py | | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| ## 'PIXL/docker' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Subdirectories with links to the relevant README </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| [export-api](./export-api/README.md) | ||
|
|
||
| [hasher-api](./hasher-api/README.md) | ||
|
|
||
| [imaging-api](./imaging-api/README.md) | ||
|
|
||
| [orthanc-anon](./orthanc-anon/README.md) | ||
|
|
||
| [orthanc-raw](./orthanc-raw/README.md) | ||
|
|
||
| [postgres](./postgres/README.md) | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Configuration** | **User docs** | **Housekeeping** | | ||
| | :--- | :--- | :--- | | ||
| | common.env | README.md | .dockerignore | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## 'PIXL/docker/hasher-api' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Configuration** | **User docs** | | ||
| | :--- | :--- | | ||
| | Dockerfile | README.md | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## 'PIXL/docker/imaging-api' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Configuration** | **User docs** | | ||
| | :--- | :--- | | ||
| | Dockerfile | README.md | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## 'PIXL/docker/orthanc-anon' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Configuration** | **User docs** | | ||
| | :--- | :--- | | ||
| | Dockerfile | README.md | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## 'PIXL/docker/orthanc-raw' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Configuration** | **User docs** | | ||
| | :--- | :--- | | ||
| | Dockerfile | README.md | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## 'PIXL/docker/export-api' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Configuration** | **User docs** | | ||
| | :--- | :--- | | ||
| | Dockerfile | README.md | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| ## 'PIXL/docker/postgres' Directory Contents | ||
|
|
||
| <details> | ||
| <summary> | ||
| <h3> Files </h3> | ||
|
|
||
| </summary> | ||
|
|
||
| | **Configuration** | **User docs** | | ||
| | :--- | :--- | | ||
| | Dockerfile | README.md | | ||
|
|
||
| </details> | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,3 +14,4 @@ | |
|
|
||
| </details> | ||
|
|
||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| ## 'PIXL/docs/design/diagrams' Directory Contents | ||
|
|
||
| ### Files | ||
|
|
||
| pixl-multi-project-config.drawio | ||
|
|
||
| pixl-multi-project-config.png | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| ## 'PIXL/docs/file_types' Directory Contents | ||
|
|
||
| ### Files | ||
|
|
||
| parquet_files.md | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| ## 'PIXL/docs/joss-publication' Directory Contents | ||
|
|
||
| ### Subdirectories | ||
|
|
||
| [figures](./figures/README.md) | ||
|
|
||
| ### Files | ||
|
|
||
| paper.bib | ||
|
|
||
| paper.md | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| ## 'PIXL/docs/joss-publication/figures' Directory Contents | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| ## 'PIXL/docs/services' Directory Contents | ||
|
|
||
| ### Files | ||
|
|
||
| ftp-server.md | ||
|
|
||
| pixl_database.md | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| ## 'PIXL/docs/setup' Directory Contents | ||
|
|
||
| ### Files | ||
|
|
||
| azure-keyvault.md | ||
|
|
||
| developer.md | ||
|
|
||
| uclh-infrastructure-setup.md | ||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not too sure about having each of the files listed for each README, feels like something that will get out of date very quickly but having a readme for the point of it and perhaps highlighting key files?
Might be worth chatting about it?