Skip to content

Commit 5acfd6a

Browse files
committed
Adding Gitbook
1 parent 397177d commit 5acfd6a

File tree

6 files changed

+81
-5
lines changed

6 files changed

+81
-5
lines changed

CONTRIBUTING.md

Lines changed: 47 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,50 @@
11
# How to contribute
22

3-
You write your own language chapter on Markdown using the layout
4-
on language.md
3+
## Language already complete
54

6-
The subtitles are only a suggestion on how to structure the chapter,
7-
by the end you only have to write all information that would also come
8-
together by the template structure.
5+
You can change and correct the files, by forking and changing the files in the directory /book/languages/[language] in your forked repo. After you're finished make a PR from your forked repo to this repo.
6+
7+
## Language not present
8+
9+
You must create a new subdir on /book/languages with the name of your language
10+
11+
### Example
12+
13+
``` md
14+
/book/languages/kotlin
15+
```
16+
17+
On this subdir you must create the files
18+
19+
``` md
20+
readme.md
21+
intro.md
22+
```
23+
24+
The Readme.md is just to get into the next language, something like this:
25+
26+
``` md
27+
# Welcome
28+
29+
Well, next we will talk a bit about Kotlin, the new JVM language by Jetbrains. Kotlin is less verbose then the original JVM language Java and is now one of the main development languages of the Android Platfom. Let's get into it.
30+
```
31+
32+
The intro should be a bit longer, it should give you an brief look at the language. Talk about the story of language or tell from where it came. Look into the file intro.md at the repo root for inspiration.
33+
34+
You should also add your new language to the /book/Summary.md by adding
35+
36+
``` md
37+
* [<Language>](/languages/<Language>/readme.md)
38+
* [Intro](/languages/<Language>/intro.md)
39+
40+
```
41+
42+
## Adding chapter
43+
44+
To start writing on a new chapter create a new file called [chapter].md at the root of language directory. Also you should add it to the /book/Summary.md
45+
46+
``` md
47+
* [<Language>](/languages/<Language>/readme.md)
48+
* [Intro](/languages/<Language>/intro.md)
49+
* [<Chapter>](/languages/<Language>/<Chapter>.md)
50+
```

book.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"root": "./book",
3+
"gitbook": ">= 3.2.3",
4+
"language": "en",
5+
"structure": {
6+
"readme": "welcome.md"
7+
}
8+
}

book/Summary.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Index
2+
3+
* [Welcome](WELCOME.md)
4+
5+
## Preface
6+
7+
* [Introduction](intro.md)
8+
9+
## Languages

book/intro.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Community-Programming-Book
2+
3+
[![Build Status](https://travis-ci.org/devRant-Squad/Community-Programming-Book.svg?branch=master)](https://travis-ci.org/devRant-Squad/Community-Programming-Book)
4+
5+
The Devrant community gathered together to create a book on
6+
multiple programming languages. We want you to understand why
7+
the languages referenced here have come to exist and why they
8+
for example use either brackets or indenting or also what great
9+
were done with them. Basically telling their story.
10+
11+
> Any fool can write code that a computer can understand. Good programmers write code that humans can understand. \
12+
> Martin Fowler

book/welcome.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Community-Programming-Book
2+
3+
[![Build Status](https://travis-ci.org/devRant-Squad/Community-Programming-Book.svg?branch=master)](https://travis-ci.org/devRant-Squad/Community-Programming-Book)
4+
5+
Hi, welcome to this Gitbook to start reading click below on Next to Introduction.
File renamed without changes.

0 commit comments

Comments
 (0)