yosata/MICADO-document-template
1
0 Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source 
Fixed a typo in the markdown formatting
This commit is contained in:
Joost van den Born authored and GitHub committed 2021-05-12 09:31:53 +02:00
1 parent f50174c881
commit cb8fdd0da7
1 file changed
+2 -2
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -2
View File
@@ -23,12 +23,12 @@ footers and headers as closely as possible.
They receive the appropriate label ([AD...] and [RD...]) and are placed in separate reference tables. All references in the `ApplicableDocuments.bib` file are They receive the appropriate label ([AD...] and [RD...]) and are placed in separate reference tables. All references in the `ApplicableDocuments.bib` file are
printed in the Applicable Documents table, but only the reference documents that are cited in text are printed in the Reference Documents table. printed in the Applicable Documents table, but only the reference documents that are cited in text are printed in the Reference Documents table.
- Fill the change record table in the document pre-amble. Depending on the document type, the location of the Change Record table might change. - Fill the change record table in the document pre-amble. Depending on the document type, the location of the Change Record table might change.
- Many acronyms used in MICADO documentation are already included in the `acronyms.tex` file. Use in the text with `\ac{}`, `\acs{}` or \acl{}. - Many acronyms used in MICADO documentation are already included in the `acronyms.tex` file. Use in the text with `\ac{}`, `\acs{}` or `\acl{}`.
- Nested acronyms are possible. Both will be printed in the acronym list. For example, MICADO - The Multi-AO Imaging CamerA for Deep Observations - uses AO in the - Nested acronyms are possible. Both will be printed in the acronym list. For example, MICADO - The Multi-AO Imaging CamerA for Deep Observations - uses AO in the
long version. Therefore, AO - Adaptive Optics - will also be printed in the acronyms list. long version. Therefore, AO - Adaptive Optics - will also be printed in the acronyms list.
- Extensive comments explaining what is what in the `.tex` and `.sty` files. - Extensive comments explaining what is what in the `.tex` and `.sty` files.
## Minimal Working Example ## An example document
Please, check the provided example PDFs to get a feel for what the document types might look like. Please, check the provided example PDFs to get a feel for what the document types might look like.
``` ```