Skip to content

Commit 8d540a9

Browse files
Update README
1 parent 4308af6 commit 8d540a9

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Build Status](https://travis-ci.org/shreyasbharath/cpp_dependency_graph.svg?branch=master)](https://travis-ci.org/shreyasbharath/cpp_dependency_graph) [![Maintainability](https://api.codeclimate.com/v1/badges/2a07b587ca6fc8b1b3db/maintainability)](https://codeclimate.com/github/shreyasbharath/cpp_dependency_graph/maintainability) [![Codacy](https://api.codacy.com/project/badge/Grade/9439dbb7fde44b5380401acba5325e62)](https://www.codacy.com/app/shreyasbharath/cpp_dependency_graph?utm_source=github.com&utm_medium=referral&utm_content=shreyasbharath/cpp_dependency_graph&utm_campaign=Badge_Grade) [![Test Coverage](https://api.codeclimate.com/v1/badges/2a07b587ca6fc8b1b3db/test_coverage)](https://codeclimate.com/github/shreyasbharath/cpp_dependency_graph/test_coverage) [![Release](https://img.shields.io/github/release/shreyasbharath/cpp_dependency_graph.svg?maxAge=3600)](https://github.com/shreyasbharath/cpp_dependency_graph/releases)
66

7-
Generates useful component dependency visualisations (in `dot` or `d3.js`) to study the architecture of C/C++ projects.
7+
Generates useful component dependency visualisations (`dot` or `d3.js`) to study the architecture of C/C++ projects.
88

99
Why do all the other languages have awesome tools to analyse codebases but C/C++ codebases do not?
1010

@@ -14,6 +14,7 @@ This tool aims to -
1414

1515
- provide multiple views into the architecture of a codebase
1616
- generate views at multiple levels of the architecture
17+
- make the resulting views genuinely useful, rich, dynamic and interactive (static views are boring)
1718

1819
## Inspiration
1920

@@ -29,6 +30,10 @@ A huge shout out to the people behind these projects.
2930

3031
`gem install cpp_dependency_graph`
3132

33+
### Help
34+
35+
`cpp_dependency_graph -h`
36+
3237
### Overall component dependency graph
3338

3439
To generate the overall component depenency graph for a project, use it like so -

docs/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
layout: home
3+
title: "Github Pages for Non-Developers: Build Web Portfolios From Scratch"
4+
---
5+
6+
<section class="sec">
7+
This is a very narrowly focused tutorial about web development aimed at novices who have absolutely no web dev experience, nor have used [Github](https://github.com) or [Git](http://git-scm.com/), or even the command line.
8+
9+
The end product is a web portfolio, built (mostly) from scratch, that is easy to edit and easy to publish _anywhere_ &ndash; Github merely provides an easy starting point.
10+
11+
(_This tutorial is in progress. [Feel free to fork it on Github](http://github.com/dannguyen/github-for-portfolios)_)
12+
</section>

0 commit comments

Comments
 (0)