|author||bnewbold <email@example.com>||2016-06-20 23:38:10 -0400|
|committer||bnewbold <firstname.lastname@example.org>||2016-06-20 23:38:10 -0400|
README: cleanup markdown
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:
+As a workaround until there is a solution in upstream `glutin`, use the
+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"
+See also XScreensaver's
+["Writing new XScreenSaver modules"](https://github.com/Zygo/xscreensaver/blob/master2/README.hacking)