├── anatomy.png ├── deck-logo.png ├── CONTRIBUTING.md └── Readme.md /anatomy.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/deckjs/deck/HEAD/anatomy.png -------------------------------------------------------------------------------- /deck-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/deckjs/deck/HEAD/deck-logo.png -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | ## `Deck` is an **OPEN Open Source Project** 2 | ----------------------------------------- 3 | 4 | ## What? 5 | 6 | Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project. 7 | 8 | ## Rules 9 | 10 | There are a few basic ground-rules for contributors: 11 | 12 | 1. **No `--force` pushes** or modifying the Git history in any way. 13 | 1. **Non-master branches** ought to be used for ongoing work. 14 | 1. **External API changes and significant modifications** ought to be subject to an **internal pull-request** to solicit feedback from other contributors. 15 | 1. Internal pull-requests to solicit feedback are *encouraged* for any other non-trivial contribution but left to the discretion of the contributor. 16 | 1. Contributors should attempt to adhere to the prevailing code-style. 17 | 18 | ## Releases 19 | 20 | Declaring formal releases remains the prerogative of the project maintainer(s). 21 | 22 | ## Changes to this arrangement 23 | 24 | This is an experiment and feedback is welcome! This document may also be subject to pull-requests or changes by contributors where you believe you have something valuable to add or change. 25 | 26 | ----------------------------------------- 27 | -------------------------------------------------------------------------------- /Readme.md: -------------------------------------------------------------------------------- 1 | # Deck 2 | 3 | Deck is a markdown driven content presentation system 4 | 5 | ![](deck-logo.png) 6 | 7 | ```sh 8 | npm install -g @deck/app 9 | ``` 10 | 11 | This is a master repo for all deck repos 12 | 13 | Please log any issues here 14 | 15 | * [deck-app](https://github.com/nearform/deck-app) (entry point) 16 | * [deck-app-unscoped](https://github.com/nearform/deck-app-unscoped) 17 | * [deck-base](https://github.com/nearform/deck-base) 18 | * [deck-base-theme](https://github.com/nearform/deck-base-theme) 19 | * [deck-example-deck](https://github.com/nearform/deck-example-deck) 20 | * [deck-gui](https://github.com/nearform/deck-gui) 21 | * [deck-present](https://github.com/nearform/deck-present) 22 | * [deck-presenter](https://github.com/nearform/deck-presenter) 23 | * [deck-skin-light](https://github.com/nearform/deck-skin-light) 24 | * [deck-terminal-logo](https://github.com/nearform/deck-terminal-logo) 25 | * [deck-upstream](https://github.com/nearform/deck-upstream) 26 | 27 | 28 | ## Technologies 29 | 30 | The deck system is built on and/or utilizes: 31 | 32 | * [Electron](http://electron.atom.io) 33 | * [Gulp](http://gulpjs.com/) 34 | * [Bespoke.js](http://markdalgleish.com/projects/bespoke.js/) 35 | * [Markdown](https://daringfireball.net/projects/markdown/) 36 | * [YAML](http://yaml.org) 37 | * [NPM](http://npmjs.org) 38 | * [GitHub](http://github.com) 39 | 40 | ![](anatomy.png) 41 | 42 | ## Issues and PR's 43 | 44 | * Please open any issues for any deck related module on the community repo. 45 | * Any module specific PR's are welcomed on the corresponding repo. 46 | 47 | ## Credits 48 | 49 | Sponsored by nearForm 50 | 51 | ### Contributors 52 | 53 | * David Mark Clements 54 | * Mihai Dima 55 | * Cristian Kiss 56 | 57 | ### Contributing 58 | 59 | Deck is an **OPEN Open Source Project**. This means that: 60 | 61 | > Individuals making significant and valuable contributions are given commit-access to a project to contribute as they see fit. A project is more like an open wiki than a standard guarded open source project. 62 | 63 | See the [`CONTRIBUTING.md`](CONTRIBUTING.md) file for more details. 64 | 65 | --------------------------------------------------------------------------------