Permalink
Browse files

update a bit the README and put some markdown on it

  • Loading branch information...
1 parent 530e0e7 commit 1d6a0d464aca60f617d7ebad4587a548c64083c9 @NotFound committed Jun 3, 2012
Showing with 32 additions and 26 deletions.
  1. +32 −26 README
View
58 README
@@ -1,40 +1,46 @@
Winxed compiler.
-Version: 1.1.devel
+================
-(C) 2009-2011 Julian Albo
+(C) 2009-2012 Julián Albo
-Build:
- You need a C++ compiler and parrot installed an in your PATH.
+## Build:
- Use 'make' to build.
- Use 'make install' to install. It gets installed in the appropiate
- directories of the parrot install.
+You need a C++ compiler and parrot installed an in your PATH.
- Alternatively, you can install Winxed using parrot plumage.
- That way a C++ compiler is not needed.
+- Use 'make' to build.
+- Use 'make install' to install. It gets installed in the appropiate
+directories of the parrot install.
+- Alternatively, you can install Winxed using parrot plumage.
+That way a C++ compiler is not needed.
-Usage:
- winxed [options] sourcefile
+## Usage:
+`winxed [options] sourcefile`
-Command line options:
+## Command line options:
- --target pir Compile to pir
- --target pbc Compile to pir, call parrot to compile to pbc
- and delete the pir file.
- -o filename Use filename for the generated file.
- -c Compile only. Same as --target pir
+* `--target pir`
+Compile to pir
+* `--target pbc`
+Compile to pir, call parrot to compile to pbc
+and delete the pir file.
+* `-o filename`
+Use filename for the generated file.
+* `-c`
+Compile only. Same as --target pir
+* `-e codfragment`
+Evaluate. The code fragment provided is compiled
+inside a 'function main(argv) {' ... ';}' enveloppe.
+Useful for one-liners and quick tests.
+* `--help`
+Show help
- -e codfragment Evaluate. The code fragment provided is compiled
- inside a 'function main(argv) {' ... ';}' enveloppe.
- Useful for one-liners and quick tests.
+See --help for more options.
- --help Show help
+## Web site:
-See --help for more options.
+[http://winxed.org/](http://winxed.org/)
-Web site:
- http://winxed.org/
+## Code repository:
-Code repository:
- https://github.com/NotFound/winxed
+[https://github.com/NotFound/winxed](https://github.com/NotFound/winxed)

0 comments on commit 1d6a0d4

Please sign in to comment.