haskell/yesod
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add note about using a VM

Browse Source
This commit is contained in:
Greg Weber 2012-07-31 17:35:31 -07:00
parent 8b9f86afad
commit ec78ad0e5e
1 changed files with 22 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -11,18 +11,27 @@ An advanced web framework using the Haskell programming language. Featuring:
* this is built in to the Haskell programming language (like Erlang) * this is built in to the Haskell programming language (like Erlang)
* handles a greater concurrent load than any other web application server * handles a greater concurrent load than any other web application server
## Learn more: http://yesodweb.com/ # Learn more: http://yesodweb.com/
## Installation: http://www.yesodweb.com/page/quickstart ## Install the latests stable Yesod: http://www.yesodweb.com/page/quickstart
cabal update && cabal install yesod cabal update && cabal install yesod
## Create a new project after installing ### Create a new project after installing
yesod init yesod init
Your application is a cabal package and you use `cabal` to install its dependencies. Your application is a cabal package and you use `cabal` to install its dependencies.
# Installing & isolation
Install conflicts are unfortunately common in Haskell development.
If you are not using any sandbox tools, you may discover that some of the other haskell installs on your system are broken.
You can prevent this by using sandbox tools: `cabal-dev` or `virthualenv`, now being renamed to `hsenv`.
Isolating an entire project with a virtual machine is also a great idea, you just need some tools to help that process.
[Vagrant](http://vagrantup.com) is a great tool for that and there is a [Haskell Platform installer](https://bitbucket.org/puffnfresh/vagrant-haskell-heroku) for it.
## Using cabal-dev ## Using cabal-dev
cabal-dev creates a sandboxed environment for an individual cabal package. cabal-dev creates a sandboxed environment for an individual cabal package.
@ -30,6 +39,8 @@ Instead of using the `cabal` command, use the `cabal-dev` command which will use
Use `yesod-devel --dev` when developing your application. Use `yesod-devel --dev` when developing your application.
## Installing the latest development version from github for use with your application ## Installing the latest development version from github for use with your application
cabal update cabal update
@ -49,13 +60,9 @@ Now run: `cabal-meta install`. If you use `cabal-dev`, run `cabal-meta --dev ins
This should work almost all of the time. You can read more on [cabal-meta](https://github.com/yesodweb/cabal-meta) This should work almost all of the time. You can read more on [cabal-meta](https://github.com/yesodweb/cabal-meta)
If you aren't building from an application, remove the `./` and create a new directory for your sources.txt first. If you aren't building from an application, remove the `./` and create a new directory for your sources.txt first.
Install conflicts are unfortunately common in Haskell development.
If you are not using any sandbox tools, you may discover that some of the other haskell installs on your system are broken.
You can prevent this by using sandbox tools. `cabal-dev` was already mentioned.
Another alternative is `virthualenv`, now being renamed to `hsenv`.
### virthualenv ## virthualenv
We recommend using [virthualenv](http://hackage.haskell.org/package/virthualenv)/[hsenv](https://github.com/Paczesiowa/hsenv) when hacking on Yesod from Linux. This is optional, but prevents your custom build of Yesod from interfering with your currently installed cabal packages. We recommend using [virthualenv](http://hackage.haskell.org/package/virthualenv)/[hsenv](https://github.com/Paczesiowa/hsenv) when hacking on Yesod from Linux. This is optional, but prevents your custom build of Yesod from interfering with your currently installed cabal packages.
@ -67,7 +74,7 @@ virthualenv will not work on Windows and maybe not Mac. Use cabal-dev instead
* cabal-dev can isolate multiple packages together by using the -s sandbox argument * cabal-dev can isolate multiple packages together by using the -s sandbox argument
### cabal-src ## cabal-src
The cabal-src tool helps resolve dependency conflicts when installing local packages. The cabal-src tool helps resolve dependency conflicts when installing local packages.
This capability is already built in if you are using cabal-dev or cabal-meta. Otherwise install cabal-src with: This capability is already built in if you are using cabal-dev or cabal-meta. Otherwise install cabal-src with:
@ -78,7 +85,7 @@ Whenever you would use `cabal install` to install a local package, use `cabal-sr
Our installer script now uses cabal-src-install when it is available. Our installer script now uses cabal-src-install when it is available.
### Cloning the repos ## Cloning the repos
The above instructions for building the latest should work well. The above instructions for building the latest should work well.
But you can clone the repos without the help of cabal-meta: But you can clone the repos without the help of cabal-meta:
@ -93,11 +100,11 @@ for repo in shakespeare persistent wai yesod; do
done done
~~~~ ~~~~
### Building your changes to Yesod ## Building your changes to Yesod
Yesod is composed of 4 "mega-repos", each with multiple cabal packages. `./script/install` will run tests against each package and install each package. Yesod is composed of 4 "mega-repos", each with multiple cabal packages. `./script/install` will run tests against each package and install each package.
#### install package in all repos ### install package in all repos
~~~ { .bash } ~~~ { .bash }
for repo in shakespeare persistent wai yesod; do for repo in shakespeare persistent wai yesod; do
@ -105,18 +112,18 @@ for repo in shakespeare persistent wai yesod; do
done done
~~~ ~~~
#### Clean build (sometimes necessary) ### Clean build (sometimes necessary)
~~~ { .bash } ~~~ { .bash }
./scripts/install --clean ./scripts/install --clean
~~~ ~~~
#### Building individual packages ### Building individual packages
~~~ { .bash }
# move to the individual package you are working on # move to the individual package you are working on
cd shakespeare-text cd shakespeare-text
~~~ { .bash }
# build and test the individual package # build and test the individual package
cabal configure -ftest --enable-tests cabal configure -ftest --enable-tests
cabal build cabal build