diff options
| author | bnewbold <bnewbold@robocracy.org> | 2016-06-20 23:38:10 -0400 |
|---|---|---|
| committer | bnewbold <bnewbold@robocracy.org> | 2016-06-20 23:38:10 -0400 |
| commit | dd5676d4e2aceb502806140bda624ecf2bc4f88b (patch) | |
| tree | 00b65a25d13fa106cf9becf1fa821323c5f2cf34 | |
| parent | 6d21a1ca15f2cb74746baf07e42ea040d318f81d (diff) | |
| download | exuberant-hacks-dd5676d4e2aceb502806140bda624ecf2bc4f88b.tar.gz exuberant-hacks-dd5676d4e2aceb502806140bda624ecf2bc4f88b.zip | |
README: cleanup markdown
| -rw-r--r-- | README.md | 23 |
1 files changed, 12 insertions, 11 deletions
@@ -10,7 +10,7 @@ It should be possible to build this project for most platforms using cargo directly. Installation and XScreensaver integration probably only works on UNIX -machines (Linux, *BSD, etc). It's only been developed and tested on Debian +machines (Linux, \*BSD, etc). It's only been developed and tested on Debian jessie, using the stable Rust toolchain (version 1.9). A patched version of the `glutin` OpenGL window generation library is required; @@ -37,27 +37,28 @@ Circa June 2016, this project requires a patched version of the `glutin` window creation library to allow re-using an existing X Window. This is only necessary for integration with X Windows, but the project won't build without it. -As a workaround until there is a solution in upstream `glutin`, use the "dependency override" feature of the cargo build tool: - - http://doc.crates.io/specifying-dependencies.html#overriding-dependencies +As a workaround until there is a solution in upstream `glutin`, use the +["dependency override"](http://doc.crates.io/specifying-dependencies.html#overriding-dependencies) +feature of the cargo build tool. Checkout the `feature-existing` branch from `https://github.com/bnewbold/glutin`, then, under this directory (exuberant-hacks), create a `.cargo/config` file with a path like: +``` paths = ["/home/bnewbold/src/glutin"] +``` ### Creating Your Own Hacks -You'll need to create at least three files with the same base name ("$HACK"): +You'll need to create at least three files with the same base name (`$HACK`): -- the rust sourcecode (src/bin/$HACK.rs) -- an XML config file (configs/$HACK.xml) -- a manpage in Markdown format (doc/$HACK.6.md) +- the rust sourcecode (`src/bin/$HACK.rs`) +- an XML config file (`configs/$HACK.xml`) +- a manpage in Markdown format (`doc/$HACK.6.md`) Then just add your HACK to the list in Makefile. -See also XScreensaver's "Writing new XScreenSaver modules" - - https://github.com/Zygo/xscreensaver/blob/master2/README.hacking +See also XScreensaver's +["Writing new XScreenSaver modules"](https://github.com/Zygo/xscreensaver/blob/master2/README.hacking) |