Almost-minimal filesystem based blog.
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.

74 lines
2.3 KiB

  1. wrt
  2. ===
  3. wrt (WRiting Tool) is a static site / blog generator and some related
  4. utilities.
  5. This project can be thought of as both a format for storing blog entries and
  6. other writing in folders and files, as well as the utilities for rendering them
  7. to a full-fledged web site. It's particularly well-suited to collections of
  8. blog entries organized by date.
  9. wrt can be found at:
  10. - [metacpan.org as App::WRT](https://metacpan.org/pod/App::WRT) - latest CPAN release
  11. - https://code.p1k3.com/gitea/brennen/wrt - latest code
  12. I have been using some version of this code to publish
  13. [p1k3](https://p1k3.com/) since 2001, and have written [various posts about
  14. it](https://p1k3.com/topics/wrt/) over the years.
  15. installation and use
  16. ====================
  17. You'll need a Unix / Linux, and a relatively recent Perl installation. In
  18. practice I know that Debian Jessie or later (or Ubuntu 16.04 or later) and Perl
  19. 5.26.1 work.
  20. The short version, git edition:
  21. $ git clone https://code.p1k3.com/gitea/brennen/wrt.git
  22. $ cd wrt
  23. $ perl Build.PL
  24. $ ./Build installdeps
  25. $ ./Build test
  26. $ ./Build install
  27. The short version, CPAN edition:
  28. $ cpan -i App::WRT
  29. Starting a new site once installed:
  30. # Set up some defaults:
  31. $ mkdir project && cd project
  32. $ wrt init
  33. # Edit an entry for January 1, 2019:
  34. $ mkdir -p archives/2019/1/
  35. $ nano archives/2019/1/1
  36. # Publish HTML to project/public/
  37. $ wrt render-all
  38. Please see the [App::WRT listing on MetaCPAN][mc] or the POD documentation in
  39. [lib/App/WRT.pm](lib/App/WRT.pm) in this repository for detailed instructions.
  40. [mc]: https://metacpan.org/pod/App::WRT
  41. copying
  42. =======
  43. wrt is copyright 2001-2019 Brennen Bearnes.
  44. wrt is free software; you can redistribute it and/or modify it under the terms
  45. of the GNU General Public License as published by the Free Software Foundation;
  46. either version 2 of the License, or (at your option) any later version.
  47. This program is distributed in the hope that it will be useful, but WITHOUT ANY
  48. WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
  49. PARTICULAR PURPOSE. See the GNU General Public License for more details.
  50. You should have received a copy of the GNU General Public License
  51. along with this program. If not, see http://www.gnu.org/licenses/