Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation - Enhancement Readme #126

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

EliotTerrier
Copy link

Creation of a README:

  • Main directory functionalities.
  • Version summary table.

@skinkie @Aurige for your review

@skinkie
Copy link
Contributor

skinkie commented Nov 7, 2023

Postpone merge until wiki related issues are sorted.


## Folder structure 📁

More information on the folders' structure can be found in the [wiki](https://github.com/ITxPT/SIRI/wiki/Structure-%26-Compatibility/#folders)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should become part of this repo.


- Explore XML examples in the */examples* subdirectory.

Further information on the examples is available on the [wiki](https://github.com/ITxPT/SIRI/wiki/Using-SIRI#how-to-use-example-files)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be part of this repo.

- **Oxygen Project File:**
- Project file: Siri.xpr

More information on the tools available for working with SIRI XML schema can be found in the [wiki](https://github.com/ITxPT/SIRI/wiki/Software-&-tools)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be part of this repo.

@ue71603
Copy link
Collaborator

ue71603 commented Mar 20, 2024

@EliotTerrier I can't rebase your PR. Can you rebase it to the current master?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants