-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from hackedy/stub-readme
add simple README
- Loading branch information
Showing
1 changed file
with
37 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |