Skip to content

Commit 43fa4c0

Browse files
Reworking the README for support changes
1 parent 09a71ce commit 43fa4c0

File tree

2 files changed

+56
-52
lines changed

2 files changed

+56
-52
lines changed

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ all of the following criteria:
2424
* The request handles an issue that has been discussed on the Lift mailing list
2525
and whose solution has been requested by the committers (and in general adheres
2626
to the spirit of the issue guidelines above).
27-
* The request includes a signature at the bottom of the /contributors.md file.
27+
* The contributor's signature is already in or added to /contributors.md file.
2828

2929
Note that only Lift committers can merge a pull request, and accepting or rejecting
3030
a pull request is entirely at the discretion of the Lift committers. By merging a

README.md

+55-51
Original file line numberDiff line numberDiff line change
@@ -13,26 +13,6 @@ Lift applications are:
1313

1414
Because Lift applications are written in [Scala](http://www.scala-lang.org), an elegant JVM language, you can still use your favorite Java libraries and deploy to your favorite Servlet Container and app server. Use the code you've already written and deploy to the container you've already configured!
1515

16-
## Issues
17-
18-
Issues on the Lift GitHub project are intended to describe actionable,
19-
already-discussed items. Committers on the project may open issues for
20-
themselves at any time, but non-committers should visit the [Lift mailing
21-
list](https://groups.google.com/forum/#!forum/liftweb) and start a discussion
22-
for any issue that they wish to open.
23-
24-
## Pull Requests
25-
26-
We will accept pull requests into the [Lift codebase](https://github.com/lift)
27-
if the pull requests meet the following criteria:
28-
29-
* The request handles an issue that has been discussed on the [Lift mailing list](http://groups.google.com/forum/#!forum/liftweb)
30-
and whose solution has been requested (and in general adheres to the spirit of
31-
the issue guidelines outlined in [CONTRIBUTING.md](https://github.com/lift/framework/blob/master/CONTRIBUTING.md)).
32-
* The request includes a signature at the bottom of the `/contributors.md` file.
33-
34-
For more details, see [CONTRIBUTING.md](https://github.com/lift/framework/blob/master/CONTRIBUTING.md).
35-
3616
## Getting Started
3717

3818
**Compatibility note:**
@@ -41,30 +21,32 @@ you'll need to use Lift 2.6 until you can upgrade your Java installation.
4121

4222
You can create a new Lift project using your favorite build system by adding Lift as a dependency:
4323

44-
#### sbt
24+
### With sbt
4525

4626
We recommend using the latest sbt version, which is currently 0.13.15, but anything 0.13.6+ will work
4727
with the instructions below.
4828

4929
Create or update your `project/plugins.sbt` file with the `xsbt-web-plugin`:
5030

51-
addSbtPlugin("com.github.siasia" %% "xsbt-web-plugin" % "3.0.2")
31+
```scala
32+
addSbtPlugin("com.github.siasia" %% "xsbt-web-plugin" % "3.0.2")
33+
```
5234

5335
Then, add the plugin and Lift to your `build.sbt` file:
5436

55-
enablePlugins(JettyPlugin)
37+
```scala
38+
enablePlugins(JettyPlugin)
5639

57-
libraryDependencies ++= {
58-
val liftVersion = "3.1.0"
59-
Seq(
60-
"net.liftweb" %% "lift-webkit" % liftVersion % "compile",
61-
"ch.qos.logback" % "logback-classic" % "1.1.3"
62-
)
63-
}
40+
libraryDependencies ++= {
41+
val liftVersion = "3.1.0"
42+
Seq(
43+
"net.liftweb" %% "lift-webkit" % liftVersion % "compile",
44+
"ch.qos.logback" % "logback-classic" % "1.2.5"
45+
)
46+
}
47+
```
6448

65-
You can [learn more on the cookbook](http://cookbook.liftweb.net/#LiftFromScratch).
66-
67-
#### Maven:
49+
### With Maven
6850

6951
You can use one of the several archetypes -- `lift-archetype-blank`, `lift-archetype-basic`, `lift-archetype-jpa-basic` -- to generate a new Lift project. You must set `archetypeRepository` and `remoteRepositories` to `http://scala-tools.org/repo-releases` or `http://scala-tools.org/repo-snapshots`, depending on whether you are using a release or the latest SNAPSHOT.
7052

@@ -79,37 +61,63 @@ Or, you can add Lift to your `pom.xml` like so:
7961
Where `${scala.version}` is `2.11` or `2.12`. Individual patch releases of the Scala compiler (e.g. 2.12.2)
8062
are binary compatible with everything in their release series, so you only need the first two version parts.
8163

82-
You can [learn more on the wiki](http://www.assembla.com/wiki/show/liftweb/Using_Maven).
64+
You can learn more about Maven integration [on the wiki](http://www.assembla.com/wiki/show/liftweb/Using_Maven).
8365

84-
## Project Organization
66+
### Learning Lift
8567

86-
The Lift Framework is divided into several components that are published independently. This organization enables you to use just the elements of Lift necessary for your project and no more.
68+
There are lots of resources out there for learning Lift. Some of our favorites include:
8769

88-
### This Repository
70+
* [The Lift Cookbook](http://cookbook.liftweb.net/)
71+
* [Simply Lift](http://simply.liftweb.net)
8972

90-
This repository, `framework`, contains the following components:
73+
If you've found one that you particularly enjoy, please open a PR to update this README!
9174

92-
#### core
75+
## Issues & Pull Requests
9376

94-
Core elements used by Lift projects. If you wish to reuse some of Lift's helpers and constructs, such as `Box`, this component may be all you need. However, a web application will most likely require one or more of Lift's components.
77+
Per our [contributing guidelines][contribfile], Issues on the Lift GitHub project are intended to
78+
describe actionable, already-discussed items. Committers on the project may open issues for
79+
themselves at any time, but non-committers should visit the [Lift mailing
80+
list](https://groups.google.com/forum/#!forum/liftweb) and start a discussion
81+
for any issue that they wish to open.
82+
83+
We will accept issues and pull requests into the Lift codebase if the pull requests meet the following criteria:
84+
85+
* The request is for a [supported version of Lift][supfile]
86+
* The request adheres to our [contributing guidelines][contribfile], including having been discussed
87+
on the Mailing List if its from a non-committer.
88+
89+
[contribfile]: https://github.com/lift/framework/blob/master/CONTRIBUTING.md
90+
[sigfile]: https://github.com/lift/framework/blob/master/contributors.md
91+
92+
## Project Organization
9593

96-
#### web
94+
The Lift Framework is divided into several components that are published independently. This organization enables you to use just the elements of Lift necessary for your project and no more.
9795

98-
This component includes all of Lift's core HTTP and web handling. Including `lift-webkit` in your build process should be sufficient for basic applications and will include `lift-core` as a transitive dependency.
96+
### This Repository
9997

100-
#### persistence
98+
This repository, `framework`, contains the following components:
10199

102-
This component includes Mapper and Record, Lift's two ORMs. While you needn't use either and can use the ORM of your choice, Mapper and Record integrate nicely with Lift's idioms. Mapper is an ORM for relational databases, while Record is a broader ORM with support for both SQL databases and NoSQL datastores.
100+
* **core:** Core elements used by Lift projects. If you wish to reuse some of Lift's helpers and
101+
constructs, such as `Box`, this component may be all you need. However, a web application will most
102+
likely require one or more of Lift's components.
103+
* **web:** This component includes all of Lift's core HTTP and web handling. Including `lift-webkit`
104+
in your build process should be sufficient for basic applications and will include `lift-core` as a
105+
transitive dependency.
106+
* **persistence:** This component includes Mapper and Record, Lift's two ORMs. While you needn't use
107+
either and can use the ORM of your choice, Mapper and Record integrate nicely with Lift's idioms.
108+
Mapper is an ORM for relational databases, while Record is a broader ORM with support for both SQL
109+
databases and NoSQL datastores.
103110

104111
### Other Repostories
105112

106113
There are a variety of other repositories available on the Lift GitHub page. While many are concerned with building Lift or are build program archetypes, there are two you will probably encounter fairly frequently as a Lift user:
107114

108115
#### modules
109116

110-
The [modules](https://github.com/liftmodules) repository contains the many add-on modules that are part of the Lift project. If you don't find a module you need here, consider [creating a module](http://www.assembla.com/spaces/liftweb/wiki/Modules) and sharing it with the community.
111-
112-
Please note that the modules project does accept pull requests.
117+
The [modules](https://github.com/liftmodules) organization contains the many add-on modules that are
118+
part of the Lift project. If you don't find a module you need here, consider
119+
[creating a module](http://www.assembla.com/spaces/liftweb/wiki/Modules) and sharing it with the
120+
community.
113121

114122
#### examples
115123

@@ -145,10 +153,6 @@ The Lift wiki is hosted on Assembla and can be found at [http://www.assembla.com
145153

146154
The ScalaDocs for each release of Lift, in additional to the actual JARs, are available on the Liftweb.net site. You can access the source code–based documentation for releases via the site's homepage or by navigating directly to the URL for the specific release. For instance, the Lift 3.0 release can be accessed at [http://liftweb.net/api/31/api/](http://liftweb.net/api/31/api/).
147155

148-
### Cookbook
149-
150-
You can find up-to-date information on the [Lift Cookbook](http://cookbook.liftweb.net/)
151-
152156
## License
153157

154158
Lift is open source software released under the **Apache 2.0 license**.

0 commit comments

Comments
 (0)