yogsototh/leiningen
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Remove mention of preview from docs; use stable branch.

Browse source
This commit is contained in:
Phil Hagelberg 2013-01-19 20:39:43 -08:00
parent be4ec8c81e
commit 3b539495a4
7 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
CONTRIBUTING.md
View file

@ -62,5 +62,5 @@ in the project root, though in most cases this can be done automatically.
Using `bin/lein` alone from the master branch without a full checkout Using `bin/lein` alone from the master branch without a full checkout
is not supported. If you want to just grab a shell script to work is not supported. If you want to just grab a shell script to work
with, use the `preview` branch. with, use the `stable` branch.

34
README.md
View file

@ -22,12 +22,12 @@ Leiningen bootstraps itself using the `lein` shell script;
there is no separate install script. It installs its dependencies there is no separate install script. It installs its dependencies
upon the first run on unix, so the first run will take longer. upon the first run on unix, so the first run will take longer.
1. [Download the script](https://raw.github.com/technomancy/leiningen/preview/bin/lein). 1. [Download the script](https://raw.github.com/technomancy/leiningen/stable/bin/lein).
2. Place it on your `$PATH`. (I like to use `~/bin`) 2. Place it on your `$PATH`. (I like to use `~/bin`)
3. Set it to be executable. (`chmod 755 ~/bin/lein`) 3. Set it to be executable. (`chmod 755 ~/bin/lein`)
The link above will get you the 2.x preview release. There is still a There is still a lot of extant material on the Web concerning the
lot of extant material on the Web concerning the older older
[Leiningen 1.x](https://raw.github.com/technomancy/leiningen/stable/bin/lein) [Leiningen 1.x](https://raw.github.com/technomancy/leiningen/stable/bin/lein)
version, which is still available if you need to work on older version, which is still available if you need to work on older
projects that aren't compatible with 2.x yet. The projects that aren't compatible with 2.x yet. The
@ -35,7 +35,7 @@ projects that aren't compatible with 2.x yet. The
has instructions on migrating to version 2. has instructions on migrating to version 2.
On Windows most users can get On Windows most users can get
[the batch file](https://raw.github.com/technomancy/leiningen/preview/bin/lein.bat). [the batch file](https://raw.github.com/technomancy/leiningen/stable/bin/lein.bat).
If you have wget.exe or curl.exe already installed and in PATH, you If you have wget.exe or curl.exe already installed and in PATH, you
can just run `lein self-install`, otherwise get the standalone jar from the can just run `lein self-install`, otherwise get the standalone jar from the
[downloads page](https://github.com/technomancy/leiningen/downloads). [downloads page](https://github.com/technomancy/leiningen/downloads).
@ -45,7 +45,7 @@ the shell script above rather than the batch file.
## Basic Usage ## Basic Usage
The The
[tutorial](https://github.com/technomancy/leiningen/blob/preview/doc/TUTORIAL.md) [tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md)
has a detailed walk-through of the steps involved in creating a new has a detailed walk-through of the steps involved in creating a new
project, but here are the commonly-used tasks: project, but here are the commonly-used tasks:
@ -86,25 +86,25 @@ The `project.clj` file in the project root should look like this:
The `lein new` task generates a project skeleton with an appropriate The `lein new` task generates a project skeleton with an appropriate
starting point from which you can work. See the starting point from which you can work. See the
[sample.project.clj](https://github.com/technomancy/leiningen/blob/preview/sample.project.clj) [sample.project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj)
file (also available via `lein help sample`) for a detailed listing of file (also available via `lein help sample`) for a detailed listing of
configuration options. configuration options.
The `project.clj` file can be customized further with the use of The `project.clj` file can be customized further with the use of
[profiles](https://github.com/technomancy/leiningen/blob/master/doc/PROFILES.md). [profiles](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md).
## Documentation ## Documentation
Leiningen documentation is organized as a number of guides: Leiningen documentation is organized as a number of guides:
* [Tutorial](https://github.com/technomancy/leiningen/blob/master/doc/TUTORIAL.md) * [Tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md)
* [Polyglot (e.g. Clojure/Java) projects](https://github.com/technomancy/leiningen/blob/master/doc/MIXED_PROJECTS.md) * [Polyglot (e.g. Clojure/Java) projects](https://github.com/technomancy/leiningen/blob/stable/doc/MIXED_PROJECTS.md)
* Leiningen [Profiles](https://github.com/technomancy/leiningen/blob/master/doc/PROFILES.md) * Leiningen [Profiles](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md)
* [Deployment & Distribution of Libraries](https://github.com/technomancy/leiningen/blob/master/doc/DEPLOY.md) * [Deployment & Distribution of Libraries](https://github.com/technomancy/leiningen/blob/stable/doc/DEPLOY.md)
* [Sample project.clj](https://github.com/technomancy/leiningen/blob/preview/sample.project.clj) * [Sample project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj)
* [Writing Plugins](https://github.com/technomancy/leiningen/blob/master/doc/PLUGINS.md) * [Writing Plugins](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md)
* [FAQ](https://github.com/technomancy/leiningen/blob/master/doc/FAQ.md) * [FAQ](https://github.com/technomancy/leiningen/blob/stable/doc/FAQ.md)
* [Contributing](https://github.com/technomancy/leiningen/blob/master/CONTRIBUTING.md) * [Contributing](https://github.com/technomancy/leiningen/blob/stable/CONTRIBUTING.md)
## Plugins ## Plugins
@ -116,9 +116,9 @@ runs, (such as `lein-tar`) then it should be added to `:plugins` in
project.clj, but if it's for your own convenience (such as project.clj, but if it's for your own convenience (such as
`swank-clojure`) then it should be added to the `:plugins` list in the `swank-clojure`) then it should be added to the `:plugins` list in the
`:user` profile in `~/.lein/profiles.clj`. See the `:user` profile in `~/.lein/profiles.clj`. See the
[profiles guide](https://github.com/technomancy/leiningen/blob/preview/doc/PROFILES.md) [profiles guide](https://github.com/technomancy/leiningen/blob/stable/doc/PROFILES.md)
for details on how to add to your `:user` profile. The for details on how to add to your `:user` profile. The
[plugin guide](https://github.com/technomancy/leiningen/blob/preview/doc/PLUGINS.md) [plugin guide](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md)
explains how to write plugins. explains how to write plugins.
## License ## License

2
doc/DEPLOY.md
View file

@ -2,7 +2,7 @@
Getting your library into [Clojars](http://clojars.org) is fairly Getting your library into [Clojars](http://clojars.org) is fairly
straightforward as is documented near the end of straightforward as is documented near the end of
[the Leiningen tutorial](https://github.com/technomancy/leiningen/blob/preview/doc/TUTORIAL.md). [the Leiningen tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.md).
However, deploying elsewhere is not always that straightforward. However, deploying elsewhere is not always that straightforward.
## Private Repositories ## Private Repositories

4
doc/PLUGINS.md
View file

@ -21,12 +21,12 @@ has `:eval-in-leiningen true`, which causes all tasks to operate
inside the leiningen process rather than starting a subprocess to inside the leiningen process rather than starting a subprocess to
isolate the project's code. Plugins need not declare a dependency on isolate the project's code. Plugins need not declare a dependency on
Clojure itself; in fact Clojure itself; in fact
[all of Leiningen's own dependencies](https://github.com/technomancy/leiningen/blob/master/project.clj) [all of Leiningen's own dependencies](https://github.com/technomancy/leiningen/blob/stable/project.clj)
will be available. However, it doesn't hurt to be specific since will be available. However, it doesn't hurt to be specific since
Leiningen's other dependencies may change in future versions. Leiningen's other dependencies may change in future versions.
See the `lein-pprint` directory See the `lein-pprint` directory
[in the Leiningen source](https://github.com/technomancy/leiningen/tree/master/lein-pprint) [in the Leiningen source](https://github.com/technomancy/leiningen/tree/stable/lein-pprint)
for a sample of a very simple plugin. for a sample of a very simple plugin.
During plugin development, having to re-run `lein install` in your During plugin development, having to re-run `lein install` in your

2
doc/PROFILES.md
View file

@ -124,7 +124,7 @@ profile, which is the profile used if you don't change it using
## Debugging ## Debugging
To see how a given profile affects your project map, use the To see how a given profile affects your project map, use the
[lein-pprint](https://github.com/technomancy/leiningen/tree/master/lein-pprint) [lein-pprint](https://github.com/technomancy/leiningen/tree/stable/lein-pprint)
plugin: plugin:
$ lein with-profile 1.4 pprint $ lein with-profile 1.4 pprint

2
doc/TEMPLATES.md
View file

@ -37,7 +37,7 @@ part of your template. For everything you add, make sure the
`liquid_cool.clj` file receives corresponding entries in that `->files` `liquid_cool.clj` file receives corresponding entries in that `->files`
call. For examples to follow, have a look inside [the \*.clj files for call. For examples to follow, have a look inside [the \*.clj files for
the built-in the built-in
templates](https://github.com/technomancy/leiningen/tree/master/resources/leiningen/new). templates](https://github.com/technomancy/leiningen/tree/stable/resources/leiningen/new).
While developing a template, if you're in the template project While developing a template, if you're in the template project
lein-newnew will pick it up and you'll be able to test it. However, if lein-newnew will pick it up and you'll be able to test it. However, if

4
doc/TUTORIAL.md
View file

@ -64,7 +64,7 @@ Next lets take a look at how projects are created.
## Creating a Project ## Creating a Project
We'll assume you've got Leiningen installed as per the We'll assume you've got Leiningen installed as per the
[README](https://github.com/technomancy/leiningen/blob/master/README.md). [README](https://github.com/technomancy/leiningen/blob/stable/README.md).
Generating a new project is easy: Generating a new project is easy:
$ lein new my-stuff $ lein new my-stuff
@ -597,7 +597,7 @@ they don't have to be re-entered every time, see `lein help
deploying`. When deploying a release that's not a snapshot, Leiningen deploying`. When deploying a release that's not a snapshot, Leiningen
will attempt to sign it using [GPG](http://gnupg.org) to prove your will attempt to sign it using [GPG](http://gnupg.org) to prove your
authorship of the release. See the authorship of the release. See the
[deploy guide](https://github.com/technomancy/leiningen/blob/master/doc/DEPLOY.md). [deploy guide](https://github.com/technomancy/leiningen/blob/stable/doc/DEPLOY.md).
for details of how to set that up. The deploy guide includes for details of how to set that up. The deploy guide includes
instructions for deploying to other repositories as well. instructions for deploying to other repositories as well.