Remove mention of preview from docs; use stable branch.
This commit is contained in:
Phil Hagelberg
parent
be4ec8c81e
commit
3b539495a4
7 changed files with 25 additions and 25 deletions
|
|
@ -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
|
||||
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
34
README.md
|
|
@ -22,12 +22,12 @@ Leiningen bootstraps itself using the `lein` shell script;
|
|||
there is no separate install script. It installs its dependencies
|
||||
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`)
|
||||
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
|
||||
lot of extant material on the Web concerning the older
|
||||
There is still a lot of extant material on the Web concerning the
|
||||
older
|
||||
[Leiningen 1.x](https://raw.github.com/technomancy/leiningen/stable/bin/lein)
|
||||
version, which is still available if you need to work on older
|
||||
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.
|
||||
|
||||
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
|
||||
can just run `lein self-install`, otherwise get the standalone jar from the
|
||||
[downloads page](https://github.com/technomancy/leiningen/downloads).
|
||||
|
|
@ -45,7 +45,7 @@ the shell script above rather than the batch file.
|
|||
## Basic Usage
|
||||
|
||||
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
|
||||
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
|
||||
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
|
||||
configuration options.
|
||||
|
||||
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
|
||||
|
||||
Leiningen documentation is organized as a number of guides:
|
||||
|
||||
* [Tutorial](https://github.com/technomancy/leiningen/blob/master/doc/TUTORIAL.md)
|
||||
* [Polyglot (e.g. Clojure/Java) projects](https://github.com/technomancy/leiningen/blob/master/doc/MIXED_PROJECTS.md)
|
||||
* Leiningen [Profiles](https://github.com/technomancy/leiningen/blob/master/doc/PROFILES.md)
|
||||
* [Deployment & Distribution of Libraries](https://github.com/technomancy/leiningen/blob/master/doc/DEPLOY.md)
|
||||
* [Sample project.clj](https://github.com/technomancy/leiningen/blob/preview/sample.project.clj)
|
||||
* [Writing Plugins](https://github.com/technomancy/leiningen/blob/master/doc/PLUGINS.md)
|
||||
* [FAQ](https://github.com/technomancy/leiningen/blob/master/doc/FAQ.md)
|
||||
* [Contributing](https://github.com/technomancy/leiningen/blob/master/CONTRIBUTING.md)
|
||||
* [Tutorial](https://github.com/technomancy/leiningen/blob/stable/doc/TUTORIAL.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/stable/doc/PROFILES.md)
|
||||
* [Deployment & Distribution of Libraries](https://github.com/technomancy/leiningen/blob/stable/doc/DEPLOY.md)
|
||||
* [Sample project.clj](https://github.com/technomancy/leiningen/blob/stable/sample.project.clj)
|
||||
* [Writing Plugins](https://github.com/technomancy/leiningen/blob/stable/doc/PLUGINS.md)
|
||||
* [FAQ](https://github.com/technomancy/leiningen/blob/stable/doc/FAQ.md)
|
||||
* [Contributing](https://github.com/technomancy/leiningen/blob/stable/CONTRIBUTING.md)
|
||||
|
||||
## 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
|
||||
`swank-clojure`) then it should be added to the `:plugins` list in 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
|
||||
[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.
|
||||
|
||||
## License
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
Getting your library into [Clojars](http://clojars.org) is fairly
|
||||
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.
|
||||
|
||||
## Private Repositories
|
||||
|
|
|
|||
|
|
@ -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
|
||||
isolate the project's code. Plugins need not declare a dependency on
|
||||
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
|
||||
Leiningen's other dependencies may change in future versions.
|
||||
|
||||
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.
|
||||
|
||||
During plugin development, having to re-run `lein install` in your
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ profile, which is the profile used if you don't change it using
|
|||
## Debugging
|
||||
|
||||
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:
|
||||
|
||||
$ lein with-profile 1.4 pprint
|
||||
|
|
|
|||
|
|
@ -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`
|
||||
call. For examples to follow, have a look inside [the \*.clj files for
|
||||
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
|
||||
lein-newnew will pick it up and you'll be able to test it. However, if
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ Next lets take a look at how projects are created.
|
|||
## Creating a Project
|
||||
|
||||
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:
|
||||
|
||||
$ 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
|
||||
will attempt to sign it using [GPG](http://gnupg.org) to prove your
|
||||
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
|
||||
instructions for deploying to other repositories as well.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue