Skip to content

Commit

Permalink
update the docu
Browse files Browse the repository at this point in the history
  • Loading branch information
ohAnd committed Dec 28, 2019
1 parent f35ed7c commit 89cc644
Show file tree
Hide file tree
Showing 7 changed files with 23 additions and 4 deletions.
10 changes: 10 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,16 @@
"isDefault": true
}
},
{
"label": "build ohConfig Doc Gen",
"type": "shell",
"command": "nearleyc language\\src\\items.nearley -o language\\items.js",
"windows": {
"command": "nearleyc language\\src\\items.nearley -o language\\items.js"
},
"group": "build"

},
{
"type": "npm",
"script": "install",
Expand Down
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,12 @@
- [ToDo's](#todos)
- [Screenshots](#screenshots)
- [home screen](#home-screen)
- [example for items](#example-for-items)
- [example for items in registry](#example-for-items-in-registry)
- [example for items as file view](#example-for-items-as-file-view)
- [Usage](#usage)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Download & Install](#download--install)
- [Download & Install](#download-amp-install)
- [Debugging](#debugging)
- [execute with debugging on](#execute-with-debugging-on)
- [Linux - OSX](#linux---osx)
Expand Down Expand Up @@ -40,10 +41,18 @@ In the first step only for the data in config files. Planned for future, to get
## Screenshots

### home screen
base screen after generating the documentation

![home screen](./docu/home.gif "home screen")

### example for items
### example for items in registry
the registry shows all groups and items as single objects, tooltip for further attributes

![example for items ](./docu/item_reg.png "example for an item file")

### example for items as file view

in the browser section the file contents can be reviewed

![example for items ](./docu/items.gif "example for an item file")

Expand Down
Binary file modified docu/home.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docu/item_reg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docu/items.GIF
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docu/items.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion ohConfigDocGen.cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ function exportItems(templateString) {
'<span style="position:absolute;left:100px;bottom:28px" class="w3-text w3-tag w3-animate-opacity">' +
'<div class="w3-container">' +
'<div class="w3-left-align">category: ' + globalItemsRegistry[key].category + '</div>' +
'<div class="w3-left-align">tags: ' + globalItemsRegistry[key].category + '</div>' +
'<div class="w3-left-align">tags: ' + globalItemsRegistry[key].tags + '</div>' +
'<div class="w3-left-align">groups: ' + globalItemsRegistry[key].groupNames + '</div>' +
'</div></span>' +
'</td>' +
Expand Down

0 comments on commit 89cc644

Please sign in to comment.