Update index.md

This commit is contained in:
Eyck Jentzsch 2021-11-18 09:31:46 +01:00 committed by GitHub
parent 2db2e9cc2d
commit 247d7a768d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 32 deletions

View File

@ -1,37 +1,43 @@
## Welcome to GitHub Pages ## Welcome to SCViewer
You can use the [editor on GitHub](https://github.com/Minres/SCViewer/edit/gh-pages/index.md) to maintain and preview the content for your website in Markdown files. SCViewer is a simpelt tool to display VCD and transaction streams created by the SystemC VCD trace implementation and the SystemC Verification Library (SCV).
The viewer has the following features
* support of VCD files (compressed and uncompressed)
* real numbers
* showing vectors and real numbers as analog (step-wise & continuous)
* various value representations of bit vectors
* support of SCV transaction recordings in various formats
* text log files (compressed and uncompressed)
* visualization of transaction relations
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. ## Key Shortcuts
### Markdown Legend:
Markdown is a lightweight and easy-to-use syntax for styling your writing. It includes conventions for * Left Mouse Button: LMB
* Middle Mouse Button: MMB
* Mouse Scroll wheel: MScrl
* Context any means Name List, Value List or Waveform
```markdown | Input | Modifier | Context | Action |
Syntax highlighted code block |-----------|----------|----------|-----------------------------------|
| LMB klick | | any | select |
# Header 1 | LMB klick | Shift | Waveform | move selected marker to position |
## Header 2 | LMB klick | Control | Waveform | move cursor to position |
### Header 3 | LMB drag | | Waveform | zoom to range |
| MMB klick | | Waveform | move selected marker to position |
- Bulleted | MScrl | | any | scroll window up/down |
- List | MScrl | Shift | any | scroll window left/right |
| Key left | | Waveform | scroll window to the left (slow) |
1. Numbered | Key right | | Waveform | scroll window to the right (slow) |
2. List | Key left | Shift | Waveform | scroll window to the left (fast) |
| Key right | Shift | Waveform | scroll window to the right (fast) |
**Bold** and _Italic_ and `Code` text | Key up | | Waveform | move selection up |
| Key down | | Waveform | move selection down |
[Link](url) and ![Image](src) | Key up | Control | Waveform | move selected track up |
``` | Key down | Control | Waveform | move selected track down |
| Key + | Control | Waveform | zoom in |
For more details see [Basic writing and formatting syntax](https://docs.github.com/en/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax). | Key - | Control | Waveform | zoom out |
| Key Pos1 | | Waveform | jump to selected marker |
### Jekyll Themes | Key End | | Waveform | jump to cursor |
| Key Del | | any | delete selected entries |
Your Pages site will use the layout and styles from the Jekyll theme you have selected in your [repository settings](https://github.com/Minres/SCViewer/settings/pages). 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://docs.github.com/categories/github-pages-basics/) or [contact support](https://support.github.com/contact) and well help you sort it out.