Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write requirements on README #14

Open
lucalanca opened this issue Nov 27, 2014 · 3 comments
Open

Write requirements on README #14

lucalanca opened this issue Nov 27, 2014 · 3 comments

Comments

@lucalanca
Copy link
Owner

and help to get people set things up.

@xtreemrage
Copy link

I have tried it out on a windows 7 laptop and a Manjor desktop (linux arch). This is mine short experience with the setup:

Windows

_Requirements_
I used the windows installer of graphviz: graphviz-X.XX.msi, remember to set the Path and point it to your bin directory. e.g. C:\Program Files (x86)\GraphvizX.XX\bin.

Manjaro 0.8.11 (arch linux)

_Requirements_
Install via yaourt the graphviz package e.g.: yaourt graphviz.

General

_Requirements_
Make sure the following grunt packages are installed:

You only need to load the grunt-angular-architecture-graph in your grunt file.

_Gruntfile_
Create the config in your grunt file, e.g.:

        angular_architecture_graph: {
            diagram: {
                files: {
                    // "PATH/TO/OUTPUT/FILES": ["PATH/TO/YOUR/FILES/*.js"]
                    "architecture": [
                        "<%= projectConfig.app %>/<%= projectConfig.project %>/**/*.js"
                    ]
                }
            }
        }

execute task and you will have your diagrams in your output folder, in this example it is in the folder architecture.


I hope it helps for your readme, thanks for this plugin.

@lucalanca
Copy link
Owner Author

Thank you so much, will add this info to the README over the weekend. Or you can do it yourself if you want to be listed as contributor (I will always mention you on the README but if you want to be listed in the commits) 👍

@xtreemrage
Copy link

I will do that!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants