Commit ac3a23c5 authored by Julian Trischler's avatar Julian Trischler

Extended readme by install command sequence.

Also improved reStructured Text file with some formattings and hyperlinks,
so it's better readable as HTML version. Introduced some meta data as well
as corrected some small mistakes.

Updated Makefile and .gitignore to new HTML readme.
parent 6774b800
......@@ -3,8 +3,13 @@
*.swo
*.swp
# ignore object and Ada library information files as well as the binary itself
# ignore object and Ada library information files
*.o
*.ali
# ignore the binary itself
wie_schbaed
# ignore the generated documentation
readme.html
......@@ -8,11 +8,16 @@
# versions if possible. :-)
#
all: wie_schbaed
wie_schbaed: wie_schbaed.adb
gnatmake wie_schbaed.adb
all: wie_schbaed doc
doc: readme.html
readme.html: readme.rst
rst2html readme.rst > readme.html
clean:
rm wie_schbaed.o wie_schbaed.ali
README
======
=================
Wie schbäd-README
=================
:Author: Julian Trischler
:Organization: IsoBeef
:Contact: software@lyse.isobeef.org
:Date: 2010-06-18
:Status: Draft
:Version: 0.8.1
Description
-----------
„Wie schbäd?“ is the Swabian phrase for „What time is it?“. So as you may
have figured out this incredible program displays given times in Swabian to
you.
===========
`„Wie schbäd?“` is the Swabian phrase for `„What time is it?“`. So as you
may have figured out this incredible program displays given times in Swabian
to you.
Installation and Compilation
----------------------------
============================
To install this awesome program, you first have to compile it for your
desired system. To do so, fire up a terminal and go into the directory where
the source code is located. Then type
the source code is located. Then type::
gnatmake wieschbaed.adb
......@@ -22,22 +29,33 @@ find a download link for it.
Once you've compiled it, you can run it.
Productive Usage
----------------
================
In productive use, you better use an alias to run this program. Insert the
following line into your ~/.bashrc or ~/.zshrc or ~/.tcshrc or whatever
shell you are using. Yeah, you get it!
following line into your ``~/.bashrc`` or ``~/.zshrc`` or ``~/.tcshrc`` or
whatever shell you are using. Yeah, you get it!::
alias wieschbaed=/path/to/wie_schbaed `date +%H:%M:%S`
This will let you get the current time with just typing 'wieschbaed'. It's
awesome, yeah!
This will let you get the current time with just typing ``wieschbaed``. It's
awesome, yeah! You can add this alias with correct set path by::
echo "alias wieschbaed='$PWD/wie_schbaed \`date +%H:%M:%S\`'" >> ~/.bashrc
Here's a simple sequence of shell commands, to get all things done::
su -c "aptitude install gnat" # install Ada compiler on Debianic systems
git clone http://git.isobeef.org/wie_schbaed.git
cd wie_schbaed
make
./wieschbaed
Further Information
===================
For more information just run the software without any parameters or view
the source code.
the `source code directly <./wie_schbaed.adb>`_ or as a `highlighted HTML
version <./wie_schbaed.html>`_.
Just one thing here: The author of this program is Julian 'Lyse' Trischler,
he has published it under Do-The-Fuck-You-Want-To-Public-License. Feel free
to edit and improve it.
he has published it under Do-What-The-Fuck-You-Want-To-Public-License. Feel
free to edit and improve it.
......@@ -3,7 +3,7 @@
-- This program displays the given time in Swabian. --
-- --
-- This software was written by Julian 'Lyse' Trischler on June 18th 2010 --
-- and is published under Do-What-The-Fuck-You-Want-To-Public-License. --
-- --
-- Version 0.8 (2010-06-18) --
----------------------------------------------------------------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment