Skip to content

Commit ed2b0f2

Browse files
committed
Written user documentation and integrated into the application.
(merge branch 'user-help')
2 parents b5d0f5b + 19b05c7 commit ed2b0f2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+1119
-10
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,6 @@
44
#ignore backup files
55
*~
66
\#*\#
7+
8+
#compiled help files
9+
help/*

Makefile

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,23 @@
11
VERSION=2.0~beta2
22

3-
tgz:
3+
tgz: help
44
tar zcf phpreport_$(VERSION).tar.gz --exclude=Makefile --exclude=*~ \
5-
--exclude=config/config.php --exclude=phpreport_$(VERSION).tar.gz *
5+
--exclude=docs \
6+
--exclude=config/config.php --exclude=*.tar.gz --exclude=*.zip *
67

78
zip: tgz
89
tar tf phpreport_$(VERSION).tar.gz | zip -@ phpreport_$(VERSION).zip
10+
11+
help:
12+
#create dirs
13+
mkdir -p help/user
14+
#copy images
15+
cp -r docs/user/i help/user; \
16+
#parse rst
17+
for i in `find -name *.rst` ; do \
18+
FILE=`echo $$i | awk '{firstpart=substr($$i, 8);x=index(firstpart,".rst");print substr(firstpart, 1,x)}'`; \
19+
rst2html $$i help/$${FILE}html; \
20+
done
21+
22+
#prevent makefile docs are up-to-date
23+
.PHONY: help

TODO

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,4 @@
11
TODO
22
====
33

4-
Version 2.0
5-
-----------
6-
7-
Documentation
8-
~~~~~~~~~~~~~
9-
10-
* Write the basic end-user documentation.
114

Lines changed: 58 additions & 0 deletions

docs/user/clients-management.rst

Lines changed: 67 additions & 0 deletions

docs/user/dia/cost-classes.dia

1.91 KB
Binary file not shown.

docs/user/dia/main-classes.dia

2.34 KB
Binary file not shown.
1.86 KB
Binary file not shown.
2.19 KB
Binary file not shown.

docs/user/i/acc-hours-screen.png

39.1 KB

0 commit comments

Comments
 (0)