Skip to content
This repository has been archived by the owner on Feb 27, 2021. It is now read-only.

A node webkit application to make simple manuals and information displays.

License

Notifications You must be signed in to change notification settings

indiealexh/NW-DesktopManual

Repository files navigation

NW-DesktopManual

A node webkit application to make simple manuals and information displays.

Image of the default theme of DesktopManual

A very basic set of code based on node-webkit and the foundation framework create crossplatform manuals, tools and displays that have no additional requirements. (this exclude the use of markdown)

You will need to download the node-webkit binarys from https://github.com/rogerwang/node-webkit to run the code.

Current Features:

  • Auto-Generated Menus based on artciles in the 'Pages' folder
  • Large and small modes
  • Large and small mode menus for better usability in all situations.

Node-Webkit

Node-Webkit is an opensource project that combines the power of the Chromium browser (google chrome) and NodeJS to create fast, easy to create desktop applications accross Windows, Mac and linux without the need for additional dependancies.

Please go read the documentation on the Node-Webkit respository

Foundation CSS Framework

Foundation css framework is used to make themeing and scaling easy, please read the documentation on the foundation website.

It is comparable to Twitter's Bootstrap framework, but I (Alex) perfer foundation.

License

The MIT License (MIT)

Copyright (c) 2014 Alex Haslam

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A node webkit application to make simple manuals and information displays.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published