You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README.md 1.0KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. # Overview
  2. This is an internal document describing how to update
  3. [Opensource Game Studio website][opengamestudio]
  4. powered by [Pelican][pelican].
  5. # Installation
  6. Install Pelican with the following command:
  7. ```
  8. sudo apt install pelican
  9. ```
  10. # Preview
  11. To preview results locally:
  12. * generate local copy with the following commands:
  13. ```
  14. cd pelican
  15. pelican -s pelicanconf.py
  16. ```
  17. * serve the local copy with the following commands:
  18. ```
  19. cd output
  20. python -m SimpleHTTPServer
  21. ```
  22. The preview should now be available at [http://localhost:8000][preview].
  23. # Publishing
  24. To publish new content:
  25. * generate public site with the following commands:
  26. ```
  27. cd pelican
  28. pelican -s publishconf.py
  29. ```
  30. * upload it to GitHub with the following commands:
  31. ```
  32. git add .
  33. git push
  34. ```
  35. The public site should now be available at
  36. [Opensource Game Studio website][opengamestudio].
  37. [opengamestudio]: http://opengamestudio.org
  38. [pelican]: http://getpelican.com
  39. [preview]: http://localhost:8000