From 36c1a432cf0ed53391e112904659923b9796406f Mon Sep 17 00:00:00 2001 From: Marius Retegan Date: Tue, 28 May 2024 10:49:13 +0200 Subject: [PATCH] Fix spelling errors --- README.md | 77 ++++++++++++++++++++++++++----------------------------- 1 file changed, 37 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index 5a0a9e734..2cbd2241f 100755 --- a/README.md +++ b/README.md @@ -7,13 +7,13 @@ ## NeXus definition developers -After making a change to the NeXus class definitions there are two important checks -to be made before commiting the change: +After making a change to the NeXus class definitions, there are two essential checks +to be made before committing the change: - 1. check whether the change does not violate any syntax rules - 2. verify whether the change looks as intended in the HTML documentation + 1. Check whether the change does not violate any syntax rules + 2. Verify whether the change looks as intended in the HTML documentation -First install the test and build requirements with this command (only run once) +First, install the test and build requirements with this command (only run once) make install @@ -21,58 +21,55 @@ Then verify syntax and build the HTML manual with this command make local -Open the HTML manual in a web brower for visual verification +Open the HTML manual in a web browser for visual verification firefox build/manual/build/html/index.html ### HTML pages with contributor information -To build the html pages that contains contributor information on the sidebar set a github access token to an environment variable called GH_TOKEN. +To build the HTML pages that contain contributor information on the sidebar, set a GitHub access token to an environment variable called GH_TOKEN. -Note: If set this will increase the build time of the documentation by approximately a factor of 4. +Note: If set, this will increase the build time of the documentation by approximately a factor of 4. setenv GH_TOKEN -### Working with nyaml files +### Working with `nyaml` files -There exists a simplified format of nxdl, which is called nyaml. -There is a [tool](https://github.com/FAIRmat-NFDI/nyaml) (`nyaml2nxdl`) available to convert between nxdl and nyaml. -This tool is already installed when you installed the requirements for this repository and it is conveniently available from the make command. +A simplified format of `nxdl` is called `nyaml`. +A [tool](https://github.com/FAIRmat-NFDI/nyaml) (`nyaml2nxdl`) is available to convert between `nxdl` and `nyaml`. +The tool was already installed when you installed the requirements for this repository, and it is conveniently available from the `make` command. -You can build nyaml files for all nxdl files with invoking +You can build `nyaml` files for all `nxdl` files with invoking: make nyaml -which will created `.yaml` files in a subfolder called `nyaml` in the respective directory. - -From this you can do your changes and create nxdl files with +which will create `.yaml` files in a subfolder called `nyaml` in the respective directory. From this, you can make your changes and create `nxdl` files with make nxdl -from the yaml files. +from the `.yaml` files. ## Repository content -These are the components that define the structure of NeXus data files -in the development directory. - -component | description --------------------------------|------------------------ -[CHANGES.rst](CHANGES.rst) | Change History -[LGPL.txt](LGPL.txt) | one proposed license model -[NXDL_VERSION](NXDL_VERSION) | the current NXDL version number -[README.md](README.md) | this file -applications/ | NXDL files for applications and instrument defs -base_classes/ | NXDL files for components -contributed_definitions/ | NXDL files from the community -impatient-guide/ | *NeXus for the Impatient* -jenkins_build | configuration for Jenkins continuous integration service -legacy_docs/ | legacy PDF copies of the NeXus definitions documentation -manual/ | Sphinx source files for the NeXus documentation -[nxdl.xsd](nxdl.xsd) | XML Schema for NXDL files -[nxdlTypes.xsd](nxdlTypes.xsd) | called by nxdl.xsd -package/ | directory for packaging this content -utils/ | various tools used in the definitions tree -www/ | launch (home) page of NeXus WWW site -xslt/ | various XML stylesheet transformations -dev_tools/ | developer tools for testing and building \ No newline at end of file +These components define the structure of NeXus data files in the development directory. + +| Component | Description | +| ------------------------------ | -------------------------------------------------------- | +| [CHANGES.rst](CHANGES.rst) | Change History | +| [LGPL.txt](LGPL.txt) | one proposed license model | +| [NXDL_VERSION](NXDL_VERSION) | the current NXDL version number | +| [README.md](README.md) | this file | +| applications/ | NXDL files for applications and instrument defs | +| base_classes/ | NXDL files for components | +| contributed_definitions/ | NXDL files from the community | +| impatient-guide/ | *NeXus for the Impatient* | +| jenkins_build | configuration for Jenkins continuous integration service | +| legacy_docs/ | legacy PDF copies of the NeXus definitions documentation | +| manual/ | Sphinx source files for the NeXus documentation | +| [nxdl.xsd](nxdl.xsd) | XML Schema for NXDL files | +| [nxdlTypes.xsd](nxdlTypes.xsd) | called by nxdl.xsd | +| package/ | directory for packaging this content | +| utils/ | various tools used in the definitions tree | +| www/ | launch (home) page of NeXus WWW site | +| xslt/ | various XML stylesheet transformations | +| dev_tools/ | developer tools for testing and building | \ No newline at end of file