Commit 4eeae647 authored by arnaudbey's avatar arnaudbey
Browse files

doc (install, contribute, readme)

parent f6663da6
This app is a quite standart symfony3 one. Depending if you're in dev or prod environnement and depending on the nature of your changes, you need to launch some commands if you want to test them. *./application/Makefile* file already contains useful "shortcuts". Feel free to add yours.
Here are some tips :
* If you remove/add/edit entities, you will certainly have to update your database.
> make dbupdate
* If you remove/add/edit javascript files, you'll need to launch grunt (and maybe edit *./application/Gruntfile.js*).
> grunt
* In prod environnement, most of changes will require clearing the cache
> make cache
* If you've made a lot of changes you can update/clearing/compiling almost everything with :
> make update
......@@ -17,7 +17,8 @@ PWD=rootpassword make install
# Notes
* When installing docker-ce, if you are using a ubuntu based distro (such as Mint), in step 4 of the ubuntu install replace ```$(lsb_release -cs) \``` with the actual name of the ubuntu distro your OS is based upon (For Mint sylvia, it would be xenial)
* During the last docker command, you should be able to leave the default value for every parameter (just press enter, except for the last one, the secret phrase, which should be changed)
* if you let default values, MW should be available at localhost:666 and the phpmyadmin at localhost:8080
* if you let default values, MW should be available at localhost:666 and the phpmyadmin at localhost:8080
* You'd better leave default values, some stuff is hardcoded...
# Update
```
......
......@@ -5,7 +5,7 @@ A Symfony3 project developed mostly ([see all contributors](CONTRIBUTORS.md)) by
* https://github.com/InnovaLangues/Magic-Word-game : the first prototype, augmented little by little by various persons from the initial code of Pauline Rebourgeon and Christine Lutian ;
* https://github.com/giacomo-mambelli/magicword : the "Bologne" prototype, coded by Giacomo Mambelli, contains the infamous "Bologna algorithm" cf. [Associated research](#Associated research) that allows the [conquer mode](https://github.com/InnovaLangues/MagicWord/wiki/Conquer).
See [the wiki](https://gricad-gitlab.univ-grenoble-alpes.fr/lzbk/MagicWord/wikis/home) for more information (or you can have a look at our [French teaser](https://vimeo.com/216809745)).
See [the wiki](https://gricad-gitlab.univ-grenoble-alpes.fr/lzbk/MagicWord/wikis/home) for more information (or you can have a look at our [French teaser](https://vimeo.com/216809745) (english subtitles available)).
### Sounds
All sounds come from [freesound.org](http://www.freesound.org/) and are licensed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/). They've been converted to mp3 when needed :
......@@ -40,3 +40,8 @@ Magic Word was designed and implemented within the GAMER workpackage that was cr
Install
-------
see [INSTALL.md](INSTALL.md)
Develop / contribute
-------
see [CONTRIBUTE.md](CONTRIBUTE.md)
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment