Tools
/
RDL-Editor
mirror of https://github.com/Minres/RDL-Editor.git
8
0
Fork 0
Code Issues 1 Packages Releases Wiki Activity

Update README.md

This commit is contained in:
Eyck Jentzsch 2017-09-25 22:46:34 +02:00 committed by GitHub
parent bc15a75974
commit 6c7515fd49
1 changed files with 6 additions and 33 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,37 +1,10 @@
## Welcome to GitHub Pages
## RDL Editor
You can use the [editor on GitHub](https://github.com/Minres/RDL-Editor/edit/master/README.md) to maintain and preview the content for your website in Markdown files.
This is an editor for [SystemRDL](http://www.accellera.org/activities/working-groups/systemrdl/).
Whenever you commit to this repository, GitHub Pages will run [Jekyll](https://jekyllrb.com/) to rebuild the pages in your site, from the content in your Markdown files.
Quote from Accellera
"SystemRDL is designed to increase productivity, quality, and reuse during the design and development of complex digital systems. It can be used to share IP within and between groups, companies, and consortiums. This is accomplished by specifying a single source for the register description from which all views can be automatically generated, which ensures consistency between multiple views. A view is any output generated from the SystemRDL description, e.g., RTL code or documentation."
### Markdown
The editor is build on top of [Eclipse Xtext](http://www.eclipse.org/Xtext/), a framework to build **D**omain **S**pecific **L**anguages (DSL).
Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for
```markdown
Syntax highlighted code block
# Header 1
## Header 2
### Header 3
- Bulleted
- List
1. Numbered
2. List
**Bold** and _Italic_ and `Code` text
[Link](url) and ![Image](src)
```
For more details see [GitHub Flavored Markdown](https://guides.github.com/features/mastering-markdown/).
### Jekyll Themes
Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/Minres/RDL-Editor/settings). The name of this theme is saved in the Jekyll `_config.yml` configuration file.
### Support or Contact
Having trouble with Pages? Check out our [documentation](https://help.github.com/categories/github-pages-basics/) or [contact support](https://github.com/contact) and we’ll help you sort it out.
It has a code generator to create the register models using the [SC-Components](https://github.com/Minres/SystemC-Components) library. Due to the nature of Xtext this generator can easily be tailored to various needs.