diff --git a/README.md b/README.md index 1c0b278..bef3d81 100755 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ sudo apt-get install ghc cabal-install ``` Now you can set up your cabal with `cabal update` and follow its instructions. -with this you will have also installed the latest GHC Haskell compiler on your +With this you will have also installed the latest GHC Haskell compiler on your system. Additionally to Haskell and its dependencies you will need the following @@ -37,7 +37,7 @@ software and libraries: * libcairo2-dev * libgtk2.0-dev -which can be installed through +Which can be installed through ```bash sudo apt-get install alex happy libpq-dev postgresql npm nodejs-legacy libpoppler-glib-dev libcairo2-dev libgtk2.0-dev @@ -51,7 +51,7 @@ npm install -g purescript npm install -g pulp ``` -for migrations also install: +For migrations also install: * libmagic-dev @@ -70,19 +70,19 @@ On how to configure your elasticsearch server, look into the ### Building -get the source with +Get the source with ```bash git clone https://github.com/nek0/eidolon.git ``` -build your sandbox with +Build your sandbox with ```bash cabal sandbox init ``` -build the source with +Build the source with ```bash make all @@ -92,7 +92,7 @@ Everything should work automagically from there. ## Deploying -First you need to set up your database, whoch just needs to be created. +First you need to set up your database, which just needs to be created. Additionally you connect to your database (with `psql` or similar) and activate the `pg_trgm` extension to the database with @@ -105,12 +105,12 @@ After compiling you will find an executable called `eidolon` in want. The executable needs to be accompanied by the folders `config` and `static` and their contents. It's best to copy them to your desired destination. -Also check `config/settings.yml` and set the values there accrding to your +Also check `config/settings.yml` and set the values there according to your configuration. The field `contactEmail` is optional, you can comment it out, but be aware. In certain jurisdictions you are required to give some contact information. -It may also be necessery to create a reverse proxy to your gallery. I would +It may also be necessary to create a reverse proxy to your gallery. I would recommend using [nginx](http://nginx.org/). ## Customizing @@ -217,8 +217,6 @@ by unhandled EXIF data. * This software uses the web Framework "Yesod" by Michael Snoyman. See more at: -* This software uses parts of the template "Parallelism" by n33co. see more at: - [eidolon]: http://eidolon.nek0.eu [stack]: https://github.com/commercialhaskell/stack/releases [elasticdocu]: https://www.elastic.co/guide/en/elasticsearch/reference/current/setup-configuration.html