Use Jekyll (#27)

This commit is contained in:
Olivier Ligot
2013-08-23 10:45:38 +02:00
parent 4761743995
commit a64f5bbe6f
7 changed files with 98 additions and 91 deletions

18
README.md Normal file
View File

@@ -0,0 +1,18 @@
# Eiffel Web Framework
Eiffel Web Framework is a framework to build web applications in Eiffel.
To get started, check out [http://oligot.github.io/EWF/](http://oligot.github.io/EWF/)!
## Documentation
Eiffel Web Framework's documentation, included in this repo in the root directory, is built with [Jekyll](http://jekyllrb.com) and publicly hosted on GitHub Pages at [http://oligot.github.io/EWF/](http://oligot.github.io/EWF/). The docs may also be run locally.
### Running documentation locally
1. If necessary, [install Jekyll](http://jekyllrb.com/docs/installation) (requires v1.x).
2. From the root `/EWF` directory, run `jekyll serve` in the command line.
- **Windows users:** run `chcp 65001` first to change the command prompt's character encoding ([code page](http://en.wikipedia.org/wiki/Windows_code_page)) to UTF-8 so Jekyll runs without errors.
3. Open [http://localhost:9000](http://localhost:9000) in your browser, and voilà.
Learn more about using Jekyll by reading their [documentation](http://jekyllrb.com/docs/home/).