xkcd-go

Golang tool to read latest, random, or a specific xkcd comic (and download it too).
git clone http://git.hanabi.in/repos/xkcd-go.git
Log | Files | Refs | README | LICENSE

README (2495B)

      1       _           _ 
      2 __  _| | _____ __| |
      3 \ \/ / |/ / __/ _` |
      4  >  <|   < (_| (_| |
      5 /_/\_\_|\_\___\__,_|
      6 ====================
      7 
      8 Fetch latest, random or any particular xkcd comic right in your terminal.
      9 
     10 Build and run
     11 =============
     12 Assuming you have golang compiler, run the following commands:
     13 
     14 $ git clone http://git.hanabi.in/repos/xkcd-go.git
     15 $ cd xkcd-go
     16 # make install # or, `go build -o xkcd src/main.go && mv xkcd /usr/local/bin/`
     17 
     18 Usage
     19 =====
     20 `xkcd' can fetch the latest xkcd comic, fetch a random comic, fetch a specific
     21 comic, or save a specific comic.
     22 
     23 Run `xkcd help' to show help message.
     24 + `xkcd' to show the latest xkcd comic.
     25 + `xkcd latest' to show the latest xkcd comic.
     26 + `xkcd random' to fetch random xkcd comic.
     27 + `xkcd get' will function same as `xkcd latest'.
     28 + `xkcd get 303', for example, to fetch the comic numbered 303.
     29 + `xkcd 807' will function same as `xkcd get 807'.
     30 + `xkcd save', to save the latest comic to `/tmp', or
     31 + `xkcd save 1312', to save the comic numbered 1312 to `/tmp'.
     32 + `xkcd explain', to explain the latest comic.
     33 + `xkcd explain 1000', to explain the comic numbered 1000.
     34 
     35 Source code
     36 ===========
     37 The source code uses git for version control.
     38 
     39 Get the source code by running:
     40 $ git clone http://git.hanabi.in/repos/xkcd-go.git
     41 
     42 The source code has three branches dev, prod and master.
     43 + dev: new features are added committed to dev.
     44 + prod: branch refers to the code ready to be used for production.
     45 + master -- git.hanabi.in makes use of stagit
     46   <https://codemadness.org/stagit.html>.  Stagit requires a master branch to
     47   generate web-front-end, and hence, the branch exists.
     48 
     49 Additionally, the source code also has few tags.
     50 + One tag is called murtaz (the one who loved xkcd so much, that he wanted this
     51 tool) -- tag named as a tribute for suggesting me to build this.
     52 + Other tags being semantic versioning (semver) of the software release.
     53 
     54 The functionality of the software is detailed in the Usage section.  I don't
     55 intend to complicate the software.  Genuine feature additions, consistency,
     56 code clean-ups and bug-fixes are welcomed.  Consider the UNIX philosophy for
     57 addition of new features.
     58 
     59 Please email patches to <me+git@hanabi.in>
     60 
     61 Authors
     62 =======
     63 + acagastya (Implementation of the stuff -- which anyone can do.)
     64 
     65 `git blame` should suffice.
     66 
     67 License
     68 =======
     69 
     70 This source code is licened under the GNU AGPLv3 license.  Read the LICENSE file
     71 to see what you can do with it, or read
     72 <https://www.gnu.org/licenses/agpl-3.0.en.html>