summaryrefslogtreecommitdiffstats
path: root/README
blob: 64143c9538375be9756f090ce91cfa5a9f34d23c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

If you'd like to help us in this project, follow these steps

Source Documents:

1. Articles collected by CK Raju http://booktype-demo.sourcefabric.org/memoirs-of-jinesh/
2. Articles published in malayal.am http://malayal.am/user/77/articles

Converting to tex:

1. Check if a document is already converted to tex formatting.
2. If an article is not converted, copy the content and apply
tex formatting (use any existing document as reference).
3. Add the file to Logbook.tex (see how other files are added).

Copy editing:

If you see an article already in tex, help with the following tasks

1. Spell checking
2. Grammar corrections (check if I is in capital letters).
3. Spacing (make sure there is a space before a 'bracket' is started,
space after a 'comma' or full stop etc.)
4. Split long lines to make small changes easy to track.

Once you complete the review add the file name to REVIEW.txt 

Generating PDF:

Install kile, texlive-xetex packages. Select XeLatex from kile toolbar
to generate PDF.

Workflow:

1. Sign up for an account with gitorious.org (optionally you can send
patches, but opening an account makes it easy for you to contribute).
2. Upload your SSH key (ssh-keygen will create a key and gitorious
'Dashboard' ie, https://gitorious.org/ when you are logged in, has option 
to upload your key)
3. Clone the repo using 'Clone repository' button on project page
(https://gitorious.org/logbook-of-an-observer/logbook-of-an-observer).
This will create a copy of the repository for your personal use.
4. Clone the repo to your local machine
git clone <url for your pesonal repo>
You can see the url next to 'Clone & push urls' on your personal repo.
5. Make your changes locally. git add, git commit, git push.
6. Request your changes to be merged using 'Request Merge' button.
(You may ask for commit access after first merge request)