You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-8Lines changed: 20 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,25 +73,37 @@ Example | Description | Use case
73
73
74
74
#### Multi-codebase integration
75
75
You might be interested to study connections between several codebases (sub-modules), codecrumbs supports that.
76
-
Simply start codecrumbs multiple times (once for each codebase), it all **will be synced in one picture** inside the browser tab.
76
+
Simply start codecrumbs multiple times (once for each codebase), it all **will be synced in one picture** inside the browser tab. To control a diagram UI - select it by clicking on it :)
77
77
78
-
E.g. for server-client application, go to the source directory for your server code and run `codecrumbs -e your-server-src/index.py -d your-server-src`, same for client `codecrumbs -e src-client/index.js -d src-client`. **Note:** codebases can be located wherever you want, simply run `codecrumbs` for directory you need.
78
+
E.g. for server-client application, go to the source directory for your server code and run `codecrumbs -e your-server-src/index.py -d your-server-src`, same for client `codecrumbs -e src-client/index.js -d src-client`.
79
+
> **Note:** codebases can be located wherever you want (**no** need to have them like mono-repo, etc.), simply run `codecrumbs` for directory you need.
79
80
80
81
<imgsrc="/docs/multi-l-c.png"width="100%"/>
81
82
82
83
#### Multi-language support
83
84
Current version supports next programming languages:
84
-
-`javascript`,
85
-
-`typescript`,
86
-
-`python`,
87
-
-`php`,
88
-
-`java`,
89
-
-`c++`,
85
+
-`javascript`
86
+
-`typescript`
87
+
-`python`
88
+
-`php`
89
+
-`java`
90
+
-`c++`
90
91
- and others which use `//` as a comment :)
91
92
92
93
Please file an issue to support other language you would like to have.
93
94
> Note: In current version only JavaScript uses AST parser to process the code, hence it offers more features (e.g. Dependencies tree)
94
95
96
+
#### Dependencies
97
+
> Note: In current version only JavaScript offers this feature
98
+
99
+
<imgsrc="/docs/dep-ui.png"width="100%"/>
100
+
101
+
UI explained:
102
+
103
+
1) Enable "Dependencies"
104
+
2) Select connection between modules
105
+
3) All involved files (two or more) will be opened in "Sidebar", so you can see “what is imported” and “its implementation”.
106
+
95
107
#### Export & import (learn and share your knowledge)
96
108
So let’s say you put together some trail of codecrumbs describing some important flow inside the project. How you can share it with others? Simply download the json file of codecrumbs store, send it to the friend, he/she uploads it to the codecrumbs and can see same you just saw!
0 commit comments