Skip to content

Commit b659da0

Browse files
committed
Added development instructions to the README
1 parent eb9e31e commit b659da0

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,23 @@ open swagger-ui-1.0/index.html
1717
How to Improve It
1818
-----------------
1919

20-
1. [Fork!](https://github.com/wordnik/swagger-ui)
21-
1. Hack.
22-
1. Submit a pull request.
20+
First, create your own fork of [wordnik/swagger-ui](https://github.com/wordnik/swagger-ui)
2321

24-
Note: The HTML and CSS are converted from Haml and Sass, which means there are currently some development
25-
dependencies. We are looking into revamping the source files and eliminating all development
26-
dependencies by using [less.js](http://lesscss.org/)
22+
To hack on swagger-ui, you'll need ruby. Then..
23+
24+
```bash
25+
# Install the middleman gem:
26+
gem install middleman
27+
28+
# Start up a development server on http://localhost:4567
29+
middleman
30+
31+
# Edit the files in `/source`
32+
# Then when you're ready to build, run:
33+
middleman build
34+
```
35+
36+
To share your changes, [submit a pull request](https://github.com/wordnik/swagger-ui/pull/new/master).
2737

2838
License
2939
-------

0 commit comments

Comments
 (0)