Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mgechev committed Apr 24, 2018
1 parent 88472af commit 9e19016
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 21 deletions.
48 changes: 27 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,55 +10,61 @@ Graphical tool for reverse engineering of Angular projects. It allows you to nav

## macOS

1. Go to the [releases page](https://github.com/mgechev/ngrev/releases).
2. Download the latest `*.dmg` file.
3. Install the application.
1. Go to the [releases page](https://github.com/mgechev/ngrev/releases).
2. Download the latest `*.dmg` file.
3. Install the application.

## Linux

1. Go to the [releases page](https://github.com/mgechev/ngrev/releases).
2. Download the latest `*.AppImage` file.
3. Run the `*.AppImage` file (you may need to `chmod +x *.AppImage`).
1. Go to the [releases page](https://github.com/mgechev/ngrev/releases).
2. Download the latest `*.AppImage` file.
3. Run the `*.AppImage` file (you may need to `chmod +x *.AppImage`).

## Windows

1. Go to the [releases page](https://github.com/mgechev/ngrev/releases).
2. Download the latest `*.exe` file.
3. Install the application.
1. Go to the [releases page](https://github.com/mgechev/ngrev/releases).
2. Download the latest `*.exe` file.
3. Install the application.

# Creating a custom theme

You can add your own theme by creating a `[theme-name].theme.json` file in Electron `[userData]/themes`. For a sample theme see [Nord](https://github.com/mgechev/ngrev/blob/master/app/nord.theme.json).

## Application Requirements

Your application needs to be compatible with the Angular's AoT compiler (i.e. you should be able to compile it with `ngc`).

## Using with Angular CLI

1. Open the Angular's application directory.
2. Make sure the dependencies are installed.
3. Open `ngrev`.
4. Click on `Select Project` and select `[YOUR_CLI_APP]/src/tsconfig.app.json`.
1. Open the Angular's application directory.
2. Make sure the dependencies are installed.
3. Open `ngrev`.
4. Click on `Select Project` and select `[YOUR_CLI_APP]/src/tsconfig.app.json`.

## Using with Angular Seed

1. Open the Angular's application directory.
2. Make sure the dependencies are installed.
3. Open `ngrev`.
4. Click on `Select Project` and select `[YOUR_CLI_APP]/src/client/tsconfig.json`.
1. Open the Angular's application directory.
2. Make sure the dependencies are installed.
3. Open `ngrev`.
4. Click on `Select Project` and select `[YOUR_CLI_APP]/src/client/tsconfig.json`.

# Demo

Demo [here](https://www.youtube.com/watch?v=sKdsxdeLWjM).

<a href="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/1.png" target="_blank"><img src="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/1.png" alt="Component template"/></a>

<a href="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/2.png" target="_blank"><img src="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/2.png" alt="Module Dependencies"></a>
<a href="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/2.png" target="_blank"><img src="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/2.png" alt="Themes"></a>

<a href="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/3.png" target="_blank"><img src="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/3.png" alt="Command + P"></a>

<a href="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/4.png" target="_blank"><img src="https://raw.githubusercontent.com/mgechev/ngrev/master/assets/4.png" alt="Module Dependencies"></a>

# Contributors

[<img alt="mgechev" src="https://avatars1.githubusercontent.com/u/455023?v=4&s=117" width="117">](https://github.com/mgechev) |[<img alt="MichalMaM" src="https://avatars0.githubusercontent.com/u/417576?v=4&s=117" width="117">](https://github.com/MichalMaM) |
:---: |:---: |
[mgechev](https://github.com/mgechev) |[MichalMaM](https://github.com/MichalMaM) |
| [<img alt="mgechev" src="https://avatars1.githubusercontent.com/u/455023?v=4&s=117" width="117">](https://github.com/mgechev) | [<img alt="MichalMaM" src="https://avatars0.githubusercontent.com/u/417576?v=4&s=117" width="117">](https://github.com/MichalMaM) |
| :---------------------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------------------: |
| [mgechev](https://github.com/mgechev) | [MichalMaM](https://github.com/MichalMaM) |

# License

Expand Down
Binary file modified assets/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9e19016

Please sign in to comment.