diff --git a/.mdlintrc b/.mdlintrc new file mode 100644 index 0000000..54ad7b1 --- /dev/null +++ b/.mdlintrc @@ -0,0 +1,9 @@ +{ + "default": true, + "MD026": { + "punctuation": ".,;:!" + }, + "MD013": { + "line_length": 300 + } +} \ No newline at end of file diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..1420173 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,6 @@ +before_install: +- npm i -g Laboratoria/mdlint + +script: +- npm run lint + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..47e7705 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,4 @@ +# How to contribute + +You write you own language chapter using the layout on chapters/language.md +The subtitles are one suggestion on how to structure the chapter, you only have to write all information that would also come together by the template structure. diff --git a/README.md b/README.md index b9f41b8..da348f5 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,10 @@ # Community-Programming-Book -Format per language: +[![Build Status](https://travis-ci.org/devRant-Squad/Community-Programming-Book.svg?branch=master)](https://travis-ci.org/devRant-Squad/Community-Programming-Book) - Language 1 - Introduction - - History - - Year of creation - - Person(s) who created it. Organization? - - Purpose of creation - - What problems it solves? What it does well. - - Relate back to why it was created (purpose). - - Basically a reason why you would use this language - - Include example code to demonstrate +The Devrant community gathered together to create a book on +multiple programming languages. We want you to understand why +this languages have come to exist and why they for example use +either brackets or indenting. - Where you should use it. (Recommend use) - - Shortcomings of the language. (Not recommended for) +> Any fool can write code that a computer can understand. Good programmers write code that humans can understand. - Martin Fowler \ No newline at end of file diff --git a/chapters/language.md b/chapters/language.md new file mode 100644 index 0000000..6467071 --- /dev/null +++ b/chapters/language.md @@ -0,0 +1,30 @@ +# [Language] + +## Introduction + +## History + +- Year of creation +- Person(s) who created it. Organization? +- Purpose of creation + +## 'What problems does it solve ? + +- What it does well. +- Relate back to why it was created (purpose). +- Basically a reason why you would use this language +- Include example code to demonstrate + +## Where you should use it + +- Recommended use + +## Shortcomings of the language + +- Not recommended for + +## Opinions on language + +## Technical information of language + +## Where to continue to read on \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..6efa60b --- /dev/null +++ b/package.json @@ -0,0 +1,9 @@ +{ + "name": "Community-Programming-Book", + "scripts": { + "lint": "mdlint ." + }, + "devDependencies": { + "mdlint": "Laboratoria/mdlint" + } +} \ No newline at end of file