diff --git a/README.md b/README.md index e69de29..1fc290e 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,30 @@ +# Remotesyn + +``` +$> remotesyn -h +Unified FPGA synthesizer frontend +(c) Joppe Blondel - 2022 + +Usage: /home/joppe/.local/bin/remotesyn [ OPTIONS ] action [ target ] ... +where OPTIONS := { -h | -l | -s host:port privkey pubkey authorized | -c config | -b build_dir } + action := { ip | syn | impl | bit | all | floorplan | sim | init } + +Options: + -h Show this help message + -l Local build + -s Start server with server information s-info. host:port is the address to bind + to, privkey and pubkey are the ssh keys of the server and authorized is the + authorized_keys file for the SSH server + -c Configuration file, defaults to project.cfg + -b Build directory, defaults to .build + +Actions: +ip Generate IP files from vendor provided libraries +syn Synthesize design for target +impl Route and place design for target +bit Generate output files and run analysis for target +all Generate IP, synthesize, route and place design for target +floorplan Run floorplan editor, currently only for local execution +sim Run simulation target +init Initialize project +``` \ No newline at end of file diff --git a/examples/spartan6/README.md b/examples/spartan6/README.md index 0bba9eb..cd8af99 100644 --- a/examples/spartan6/README.md +++ b/examples/spartan6/README.md @@ -1,5 +1,5 @@ # Spartan 6 example -Run full toolchain: `remotesyn -l all total` -Run simulation: `remotesyn -l sim presim_total` -Run post-simulation (after synthesis and implementation): `remotesyn -l sim postsim_total` \ No newline at end of file +Run full toolchain: `remotesyn -l all total`
+Run simulation: `remotesyn -l sim presim_total`
+Run post-simulation (after synthesis and implementation): `remotesyn -l sim postsim_total`