Review: Approve Tested and working :)
Just 1 small nit for the English language. Diff comments: > === modified file 'README.txt' > --- README.txt 2018-12-30 11:45:03 +0000 > +++ README.txt 2019-04-07 10:02:44 +0000 > @@ -125,60 +126,63 @@ > See also > https://docs.djangoproject.com/en/dev/ref/django-admin/#examples-of-using-different-ports-and-addresses > for further details. > > + > Dependencies between website and widelands source code > ====================================================== > > -Some parts of the website need access to the source code of widelands: > - > -* Online help/Encyclopedia > -* Possibility to upload a map onto the local website > -* Source code documentation > - > -You will need the widelands source code for this, see > +Some parts of the website need access to the source code of widelands, other > +parts need some widelands executables. > + > +Source code only > +---------------- > + > +The documentation is made out of the source code. To get a copy, see: > > https://wl.widelands.org/wiki/BzrPrimer/ > > After the source code is downloaded, adjust the path of > > -WIDELANDS_SVN_DIR > - > -in local_settings.py to the path where the widelands source code is found. > - > -Setting up the online help / encyclopedia > ------------------------------------------ > - > -You will need graphviz to generate the graphs for the online help. On Ubuntu > run: > +WIDELANDS_SVN_DIR = '/path/to/widelands/trunk' > + > +in mainpage/local_settings.py to the path where the widelands source code > can be > +found. Then run: > + > + $ ./manage.py create_docs > + > +After finishing without errors, type localhost:8000/documentation/index.html > +in your browsers addressbar or click on "Development -> Documentation". > + > +Widelands executables > +--------------------- > + > +Widelands executables are needed to: > + > +* Upload maps to the website > +* Create the Encylopdia > + > +Either install widelands as a program to your operating system, or create > the > +binarys by compiling the source code. If you want to compile, run: binarys -> binaries > + > + $ ./compile.sh -r > + > +inside of the WIDELANDS_SVN_DIR to create a release build. > + > +Uploading maps should work now. > + > +Creating the encyclopdia needs graphviz to generate the graphs. On Ubuntu > run: > > $ sudo apt-get install graphviz > > -To generate the online help database switch to your local environment and > run: > +To generate the online help switch to your local environment and run: > > $ ./manage.py update_help > > -After that you can create the overview pdf files with > +Now you can create the economy graphs: > > $ ./manage.py update_help_pdf > > -Setting up widelands source code documentation > ----------------------------------------------- > - > -There is a small helper script to get the documenation. Be sure > -you have set WIDELANDS_SVN_DIR set in local_settings.py. Run: > - > - $ ./manage.py create_docs > - > -After finishing without errors, type localhost:8000/documentation/index.html > -in your browsers addressbar or click on "Development -> Documentation". > - > - > -Uploading a map to the local website > ------------------------------------- > - > -Compile the widelands binaries by using the compile.sh script > - > - $ ./compile.sh > - > -Now you should be able to upload a map onto your local website. > +You can access the encyclopdia by clicking on 'The Game -> Encyclopedia' now. > + > > Contact > ======= -- https://code.launchpad.net/~widelands-dev/widelands-website/mv_main_files/+merge/365634 Your team Widelands Developers is subscribed to branch lp:widelands-website. _______________________________________________ Mailing list: https://launchpad.net/~widelands-dev Post to : widelands-dev@lists.launchpad.net Unsubscribe : https://launchpad.net/~widelands-dev More help : https://help.launchpad.net/ListHelp
