path: root/README
blob: 43dffa13a3700a126cab7a057cd9998c25e1ddf5 (plain)
  1. Ikiwiki w/ translations
  2. =======================
  3. Ikiwiki[1] is a perl-based wiki compiler.
  4. This is routines to manage translatable parts of Ikiwiki and translations into
  5. the following locales:
  6.  * danish (da) by Jonas Smedegaard <>
  7. Getting the source
  8. ------------------
  9. This README file and related scripts are available at
  10. as a GIT repository. Pull it like this:
  11.     git clone
  12. Installation
  13. ------------
  14. To pull in all translatable and translated parts, do this:
  15.     make
  16. To pull in all parts with write access to the repository, do this:
  17.     make origin_ikiwiki='$(underlay).git'
  18. To remove all translatable and translated parts, and anything else below those
  19. directories without warning, do this:
  20.     make ultraclean
  21. Customizing
  22. -----------
  23. To publish your own forked repository through web, you first need to create a
  24. special public repository that you "push" your changes into from your private
  25. working repository - like this:
  26.     GIT_DIR=public_dir/repository_name.git git --bare init --shared
  27.     chmod +x public_dir/repository_name.git/hooks/post-update
  28. To actually use your newly created public repository created above, you need to
  29. populate it with your current working repository (the --all option is only this
  30. once, not on subsequent pushes) - like this:
  31.     git config remote.origin.url git-reference-to-public-repository
  32.     git push --all
  33. To resyncronize an older fork of the repository with newer upstream changes, do
  34. like this (skip first command on subsequent updates):
  35.     git remote add ikiwiki
  36.     git pull ikiwiki master
  37. ----
  38. References:
  39. [1]