Skip to content

Commit

Permalink
Updated Readme and License
Browse files Browse the repository at this point in the history
  • Loading branch information
Alexandre Gautier committed Oct 12, 2016
1 parent 7ca843d commit 734b31e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
6 changes: 3 additions & 3 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <your_file(s)>
```

```
./betty-doc.pl <single_file>
./betty-doc.pl <your_file(s)>
```

### 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)

0 comments on commit 734b31e

Please sign in to comment.