Skip to content

Commit

Permalink
Merge pull request #4 from hackedy/stub-readme
Browse files Browse the repository at this point in the history
add simple README
  • Loading branch information
hackedy authored May 14, 2020
2 parents 6411904 + bfa699a commit 03989d9
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# P4PP

p4pp is a standards-compliant preprocessor for the [P4 Language](https://p4.org)
language.

## Installing from source
1. Check the installed version of OCaml:
```
ocamlc -v
```
If the version is less than 4.09.0, upgrade:
```
opam switch 4.09.0
```

1. Use OPAM to build and install p4pp.
```
opam pin add p4pp <path to root of p4pp repo>
```

## Running p4pp

TODO

## Contributing

p4pp is an open-source project. We encourage contributions!
Please file issues on
[Github](https://github.com/cornell-netlab/p4pp/issues).

## Credits

p4pp was written by Nate Foster.

## License

p4pp is released under the [Apache2 License](LICENSE).

0 comments on commit 03989d9

Please sign in to comment.