docs: list of major technologies used by Etcher (#826)

This commit notes down the most important technologies used by Etcher,
so that contributors know what they should focus their learning in.

Signed-off-by: Juan Cruz Viotti <jviotti@openmailbox.org>
This commit is contained in:
Juan Cruz Viotti 2016-11-03 16:00:18 -04:00 committed by GitHub
parent 5ac486d941
commit 71a73ab6c8

View File

@ -4,6 +4,23 @@ Etcher Architecture
This document aims to serve as a high-level overview of how Etcher works,
specially oriented for contributors who want to understand the big picture.
Technologies
------------
This is a non exhaustive list of the major frameworks, libraries, and other
technologies used in Etcher that you should become familiar with:
- [Electron][electron]
- [NodeJS][nodejs]
- [AngularJS][angularjs]
- [Redux][redux]
- [ImmutableJS][immutablejs]
- [Bootstrap][bootstrap]
- [Sass][sass]
- [Flexbox Grid][flexbox-grid]
- [Mocha][mocha]
- [JSDoc][jsdoc]
Module architecture
-------------------
@ -94,4 +111,13 @@ be documented instead!
[exit-codes]: https://github.com/resin-io/etcher/blob/master/lib/src/exit-codes.js
[cli-dir]: https://github.com/resin-io/etcher/tree/master/lib/cli
[gui-dir]: https://github.com/resin-io/etcher/tree/master/lib/gui
[electron]: http://electron.atom.io
[nodejs]: https://nodejs.org
[angularjs]: https://angularjs.org
[redux]: http://redux.js.org
[immutablejs]: http://facebook.github.io/immutable-js/
[bootstrap]: http://getbootstrap.com
[sass]: http://sass-lang.com
[flexbox-grid]: http://flexboxgrid.com
[mocha]: http://mochajs.org
[jsdoc]: http://usejsdoc.org