From 734b31e998d2f4223466442e1b0f03478ae1b330 Mon Sep 17 00:00:00 2001 From: Alexandre Gautier Date: Wed, 12 Oct 2016 15:42:35 +0300 Subject: [PATCH] Updated Readme and License --- LICENSE | 6 +++--- README.md | 18 ++++++++++++------ 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/LICENSE b/LICENSE index 9cecc1d..eae2ec2 100644 --- a/LICENSE +++ b/LICENSE @@ -631,8 +631,8 @@ to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. - {one line to give the program's name and a brief idea of what it does.} - Copyright (C) {year} {name of author} + Betty - Holberton School coding style checker + Copyright (C) 2016 Alexandre GAUTIER This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail. If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode: - {project} Copyright (C) {year} {fullname} + Betty Copyright (C) 2016 Alexandre GAUTIER This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. diff --git a/README.md b/README.md index f0ec66b..19c10b3 100644 --- a/README.md +++ b/README.md @@ -2,20 +2,26 @@ [![Build Status](https://travis-ci.org/holbertonschool/Betty.svg?branch=master)](https://travis-ci.org/holbertonschool/Betty) -### Run +### Documentation + +Please visit the [Betty Wiki](https://github.com/holbertonschool/Betty/wiki) for the full specifications of Betty coding and documentation styles. + +You'll also find some references and some tools for common text editors such as Emacs and Atom. + +### Usage + Run the following command to check if your code/doc fits the Betty Style (mostly inspired from the Linux Kernel style): + ``` ./betty-style.pl ``` + ``` -./betty-doc.pl +./betty-doc.pl ``` ### Atom editor + Here's [a package](https://atom.io/packages/linter-betty) for Atom to check Betty-style code and documentation Here's [a package](https://atom.io/packages/kernel-docstring) for Atom to generate Betty-style documentation for your C functions - -### Reference - * From [Linux Kernel repository](http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree) - * Under the [GNU General Public License](https://www.gnu.org/licenses/gpl.html)