openstack
/
ironic-webclient
Code Issues Proposed changes

Correct markup of README.md 

Reformat the markup a little as #Text is not rendered correctly
by all markdown parsers.

New lines and indents are added to provide better readability and
aesthetics when not using a rendered view.

Trivial-Fix
Change-Id: I1e9adfb802a6f07696820b6229912fba48869e1b
This commit is contained in:
Gerard Braad 2016-06-22 09:23:20 +00:00
parent efe6d4911f
commit 0ae88d1383
1 changed files with 21 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -8,35 +8,40 @@ It is imperative that the design and infrastructure of this project makes it
easy to package for various linux distributions. As such, the following
decisions have been made:
#####The project must be fully functional directly from source.
* ECMAScript 5 only, no transpiled languages such as TypeScript or
CoffeeScript.
* All javascript libraries used at runtime (in the browser) must be committed
to source.
##### The project must be fully functional directly from source.
* ECMAScript 5 only, no transpiled languages such as TypeScript or
CoffeeScript.
* All javascript libraries used at runtime (in the browser) must be committed
to source.
Note that we do not guarantee performance if running in this mode. Certain
things, such as in-browser CSS compilation will severely degrade the
performance of this application.
##### The project must be easy to develop on.
* We use common javascript tooling to assist in development (npm, gulp,
eslint, bower, etc).
* These tools are supportive, but not required, as such they are considered to
be environmental, and thus not committed to source.
#####The project must be compatible with the OpenStack License.
* All runtime dependencies and development tools must use licenses compatible
with the Apache2.0 license.
##### The project must be easy to develop on.
* We use common javascript tooling to assist in development (npm, gulp,
eslint, bower, etc).
* These tools are supportive, but not required, as such they are considered to
be environmental, and thus not committed to source.
##### The project must be compatible with the OpenStack License.
* All runtime dependencies and development tools must use licenses compatible
with the Apache2.0 license.
## Development Server
1. Check out the code.
2. Run `npm install`
1. Check out the code.
2. Run `npm install`
1. Realize that you don't have node installed. Install node, and npm.
2. If using a Debian/Ubuntu system, also install node.js and nodejs-legacy.
3. Then try again.
3. Run `npm start`
3. Run `npm start`
## Other options