brennen
/
git-feed
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
Browse Source

better docs

Brennen Bearnes 4 years ago
parent
870fa5d231
commit
7cc1ab1ffb
2 changed files with 64 additions and 0 deletions
Split View Show Diff Stats
  1. 32
    0
      README.pod
  2. 32
    0
      git-feed

+ 32
- 0
README.pod View File 

@@ -10,6 +10,24 @@ git-feed [ B<--project_url=...> ]
10 10
11 11 
 =head1 DESCRIPTION
12 12
13 
+I keep a lot of projects in git, and I like to provide feeds for things I'm
14 
+working on.  This script wraps git and XML::Atom::SimpleFeed to generate a
15 
+basic Atom feed of commits.  It tries to use information already available in
16 
+the environment, but needs to be given a URL for your project (and probably for
17 
+the feed itself).
18 
+
19 
+It can be configured for a given repository by doing something like the
20 
+following:
21 
+
22 
+  git config feed.projecturl https://p1k3.com/userland-book/
23 
+  git config feed.url https://p1k3.com/userland-book/feed.xml
24 
+  echo 'userland: a book about the command line for human beings' > .git/description
25 
+
26 
+I have I<no idea> whether this sort of thing is considered an acceptable use of
27 
+git configuration, but it seems to work.
28 
+
29 
+...or you can supply various options on the command line.
30 
+
13 31 
 B<--project_url=...>
14 32
15 33 
 =over
 
@@ -56,6 +74,20 @@ user.name.
56 74
57 75 
     git feed --project_url=https://p1k3.com/userland-book/ > feed.xml
58 76
77 
+=head1 INSTALLING
78 
+
79 
+I'll wrap this in a module and add a build script.  For now, install
80 
+XML::Atom::SimpleFeed first.  I would probably do that either with:
81 
+
82 
+    cpanp -i XML::Atom::SimpleFeed
83 
+
84 
+or:
85 
+
86 
+    apt-get install libxml-atom-simplefeed-perl
87 
+
88 
+...depending on which one gave me less static on a given system.  I don't
89 
+really know what I'm doing in the Perl ecosystem any more, though.
90 
+
59 91 
 =head1 AUTHOR
60 92
61 93 
 Brennen Bearnes <bbearnes@gmail.com>

+ 32
- 0
git-feed View File 

@@ -12,6 +12,24 @@ git-feed [ B<--project_url=...> ]
12 12
13 13 
 =head1 DESCRIPTION
14 14
15 
+I keep a lot of projects in git, and I like to provide feeds for things I'm
16 
+working on.  This script wraps git and XML::Atom::SimpleFeed to generate a
17 
+basic Atom feed of commits.  It tries to use information already available in
18 
+the environment, but needs to be given a URL for your project (and probably for
19 
+the feed itself).
20 
+
21 
+It can be configured for a given repository by doing something like the
22 
+following:
23 
+
24 
+  git config feed.projecturl https://p1k3.com/userland-book/
25 
+  git config feed.url https://p1k3.com/userland-book/feed.xml
26 
+  echo 'userland: a book about the command line for human beings' > .git/description
27 
+
28 
+I have I<no idea> whether this sort of thing is considered an acceptable use of
29 
+git configuration, but it seems to work.
30 
+
31 
+...or you can supply various options on the command line.
32 
+
15 33 
 B<--project_url=...>
16 34
17 35 
 =over
 
@@ -58,6 +76,20 @@ user.name.
58 76
59 77 
     git feed --project_url=https://p1k3.com/userland-book/ > feed.xml
60 78
79 
+=head1 INSTALLING
80 
+
81 
+I'll wrap this in a module and add a build script.  For now, install
82 
+XML::Atom::SimpleFeed first.  I would probably do that either with:
83 
+
84 
+    cpanp -i XML::Atom::SimpleFeed
85 
+
86 
+or:
87 
+
88 
+    apt-get install libxml-atom-simplefeed-perl
89 
+
90 
+...depending on which one gave me less static on a given system.  I don't
91 
+really know what I'm doing in the Perl ecosystem any more, though.
92 
+
61 93 
 =head1 AUTHOR
62 94
63 95 
 Brennen Bearnes <bbearnes@gmail.com>