getting_started.rst 1.5 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. Getting Started
  2. ===============
  3. To build Gluon, after checking out the repository change to the source root directory
  4. to perform the following commands:
  5. ::
  6. git clone git://github.com/freifunk-gluon/site-ffhl.git site # Get the Freifunk Lübeck site repository - or use your own!
  7. make update # Get other repositories used by Gluon
  8. make # Build Gluon
  9. When calling make, the OpenWRT build environment is prepared/updated. To rebuild
  10. the images only, just use:
  11. ::
  12. make images
  13. The built images can be found in the directory `images`. Of these, the factory
  14. images are to be used when flashing from the original firmware a device came with,
  15. and sysupgrade is to upgrade from other versions of Gluon or any other OpenWRT-based
  16. system.
  17. For the build reserve 6GB of disk space. The build requires packages
  18. for `subversion`, ncurses headers (`libncurses-dev`) and zlib headers
  19. (`libz-dev`).
  20. There are two levels of `make clean`:
  21. ::
  22. make clean
  23. will ensure all packages are rebuilt; this is what you normally want to do after an update.
  24. ::
  25. make dirclean
  26. will clean the entire tree, so the toolchain will be rebuilt as well, which is
  27. not necessary in most cases, and will take a while.
  28. So all in all, to update and rebuild a Gluon build tree, the following commands should be used:
  29. ::
  30. git pull
  31. (cd site && git pull)
  32. make update
  33. make clean
  34. make