From 1e234949d4f8dc329d0dfeecb6b633ff5ad93940 Mon Sep 17 00:00:00 2001 From: Gary Deer Date: Thu, 28 Aug 2014 21:52:01 -0500 Subject: [PATCH] Delete README.md~ --- README.md~ | 130 ----------------------------------------------------- 1 file changed, 130 deletions(-) delete mode 100644 README.md~ diff --git a/README.md~ b/README.md~ deleted file mode 100644 index 908eb71..0000000 --- a/README.md~ +++ /dev/null @@ -1,130 +0,0 @@ -Marginalia 0.7.1 -================ - -**[Marginalia has a new home](http://blog.fogus.me/2013/08/12/marginalia-has-a-new-home/)** - -![marginalia](http://farm8.staticflickr.com/7057/6828224448_32b51e5784_z_d.jpg "Marginalia") - -*Ultra-lightweight literate programming[1] for [Clojure](http://clojure.org) and ClojureScript inspired by [docco](http://jashkenas.github.com/docco/)* - -Marginalia is a source code documentation tool that parses Clojure and ClojureScript code and outputs a side-by-side source view with appropriate comments and docstrings aligned. - -To get a quick look at what the Marginalia output looks like, [visit the official site](http://gdeer81.github.io/marginalia/). - -**[View the release notes for this version of Marginalia](https://github.com/gdeer81/marginalia/blob/master/docs/release-notes/marginalia-v0.7.1-release-notes.markdown)** - -Usage ------ - -Currently Marginalia can be used in a number of ways as described below. - -### Leiningen - -[http://github.com/gdeer81/lein-marginalia](http://github.com/gdeer81/lein-marginalia) - -To use Marginalia with Leiningen add the following code to the project's `project.clj` file: - -With Leiningen 1.x, add `[lein-marginalia "0.7.1"]` to your project.clj's `:dev-dependencies` argument of the `defproject` function, then run `lein deps`. -With Leiningen 2.x, add `[[lein-marginalia "0.7.1"]]` to the `:plugins` entry in either your project.clj file or your `:user` profile. -See the [lein-marginalia](http://github.com/gdeer81/lein-marginalia) page for more details. - -Once installed, you can generate your complete source documentation with the command: - - lein marg - -Marginalia accepts options as described below: - - * -d --dir Directory into which the documentation will be written (default `docs`) - * -f --file File into which the documentation will be written (default `uberdoc.html`) - * -n --name Project name (if not given will be taken from `project.clj`) - * -v --version Project version (if not given will be taken from `project.clj`) - * -D --desc Project description (if not given will be taken from `project.clj`) - * -a --deps Project dependencies in the form `::;...` (if not given will be taken from `project.clj`) - * -c --css Additional css resources `;;...` (if not given will be taken from `project.clj`) - * -j --js Additional javascript resources `;;...` (if not given will be taken from `project.clj`) - * -m --multi Generate each namespace documentation as a separate file - -### Maven - -The [zi plugin](https://github.com/pallet/zi) supports Marginalia. - -Add this code to the project's `pom.xml` file, and run the command `mvn zi:marginalia`. - -```xml - - org.cloudhoist.plugin - zi - 0.5.0 - - autodoc/marginalia - - -``` - -And the following to the project's `settings.xml` file. - -```xml - - org.cloudhoist.plugin - - - - - clojure-dev - - - sonatype-snapshots - http://oss.sonatype.org/content/repositories/releases - - - - - - - clojure-dev - -``` - -Contributors and thanks ------------------------ - -I would like to thank Zachary Kim for taking a pile of incoherent code and making it something worth using. Marginalia would be nothing without his hard work and vision. - -I would also like to thank Justin Balthrop and Brenton Ashworth for their support and code contributions. - -Notes ------ - -[1] While the phrase *ultra-lightweight literate programming* is used to describe Marginalia, it is in no way a tool for classical literate programming. That is, Marginalia is a linear documentation generator allowing no out-of-order reassembly of source. - -Marginalia is... ----------------- - -*sorted by first commit* - -- [Fogus](http://fogus.me/fun/) -- [Zachary Kim](https://github.com/zk) -- [Justin Balthrop](https://github.com/ninjudd) -- [Brenton Ashworth](https://github.com/brentonashworth) -- [Nicolas Buduroi](https://github.com/budu) -- [Michael Harrison](https://github.com/goodmike) -- [Anthony Grimes](https://github.com/Raynes) -- [Sam Ritchie](https://github.com/sritchie) -- [Hugo Duncan](https://github.com/hugoduncan) -- [Vadim](https://github.com/dm3) -- [Meikel Brandmeyer](https://github.com/kotarak) -- [Paul Dorman](https://github.com/pauldorman) -- [Deepak Giridharagopal](https://github.com/grimradical) -- [Tero Parviainen](https://github.com/teropa) -- [MerelyAPseudonym](https://github.com/MerelyAPseudonym) -- [Ivan](https://github.com/ivantm) -- [benjamin bader] (https://github.com/benjamin-bader) - -If I've missed your name then please ping me. - -License -------- - -Copyright (C) 2010-2013 Fogus and contributors. - -Distributed under the Eclipse Public License, the same as Clojure.