Skip to content

Commit 868e39b

Browse files
committed
adiciona readme
1 parent 8ee3437 commit 868e39b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

readme.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# ArchPython
2+
## An architectural conformance analysis tool for systems written in Python
3+
4+
### Installing Dependencies
5+
6+
Use the requirement file to install external dependencies.
7+
8+
For example:
9+
10+
``` pip install -r requirements ```
11+
12+
### Running
13+
14+
To run ArchPython, open the command prompt in this folder and type:
15+
16+
```python src/main.pay <path_to_architeture_file> <path_to_project_source_code>```
17+
18+
For example:
19+
20+
```python src\main.py C:\dev\ArchPython\examples\PythonToDo\architecture.json C:\dev\ArchPython\examples\PythonToDo```
21+
22+
***
23+
## More information coming soon!

0 commit comments

Comments
 (0)