Skip to content

Commit

Permalink
doc: more pretty
Browse files Browse the repository at this point in the history
  • Loading branch information
h1alexbel committed Apr 15, 2024
1 parent 8d5d963 commit e7e8262
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions steps/README.md
@@ -1,9 +1,12 @@
### How it Works?
The entire process of gathering metrics from GitHub repos consists of these
steps:
* **Discovering**. Get the list of repos from GitHub and then create directories for them.
* **Polishing**. Delete directories that don't exist in the list of required repositories.
* **Unregistering**. Clean directories from the CSV register if their clones are absent.
* **Discovering**. Here we fetch the list of repos from GitHub and then create
directories for them.
* **Polishing**. Then we delete directories that don't exist in the list of
required repositories.
* **Unregistering**. During this step, we clean directories from the CSV
register if their clones are absent.
* **Cloning**. In this step we run `git clone` on found repositories.
* **JPEEK**. Here, we build those gathered repositories and run
[jpeek](https://github.com/cqfn/jpeek) on them.
Expand Down

0 comments on commit e7e8262

Please sign in to comment.