Skip to content

Commit

Permalink
Reorganize README content (highlight folder structure)
Browse files Browse the repository at this point in the history
  • Loading branch information
Querela committed Jun 12, 2023
1 parent 5b8952c commit 1aab315
Showing 1 changed file with 10 additions and 8 deletions.
18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,23 @@ This repo contains AsciiDoc sources, images, examples and schema files for the C
* [CLARIN Federated Content Search - FCS **Data Views 1.0**: `fcs-dataviews-1.0/index.adoc`](fcs-dataviews-1.0/index.adoc)
* _WIP_ [CLARIN Federated Content Search - FCS **AAI 1.0**: `fcs-aai/index.adoc`](fcs-aai/index.adoc)

### Folder structure

All the specification documents are structured as follows in their sub folders:
- `index.adoc` -- AsciiDoc entrypoint document that bundles and includes single chapters into one
- `attachments/` -- (optional) with schema files or similar
- `examples/` -- (optional) examples (or fragments) that are included in the specification document
- `images/` -- (optional) for images that will be in the specification
- `themes/` -- links to the global [`themes/`](themes/) folder with the `clarin` theme

### AsciiDoc

* [`themes/`](themes/) for CLARIN
* global [`themes/`](themes/) folder for CLARIN

### How to build

Please take a look at the [Github Actions workflow definitions in `.github/workflows`](.github/workflows). All the specification documents will be built automatically when their source files change. (_NOTE: changes to theme files may require manually triggering the build._)

All the specification documents are structured as follows in their sub folders:
- `index.adoc` entrypoint document that bundles and includes single chapters into one
- `attachments/` (optional) with schema files or similar
- `examples/` (optional) examples (or fragments) that are included in the specification document
- `images/` (optional) for images that will be in the specification
- `themes/` links to the global [`themes/`](themes/) folder with the `clarin` theme

You can build the specifications documents yourself with:

```bash
Expand Down

0 comments on commit 1aab315

Please sign in to comment.