Skip to content

Commit 8ef4c58

Browse files
authored
Update README.md
1 parent f68f6c7 commit 8ef4c58

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

README.md

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,39 @@ perform code formatting. The logic behind recognizing and rewriting deprecated c
77
can be found in the [Deprecations.jl](https://github.com/JuliaComputing/Deprecations.jl) package,
88
which makes use of [CSTParser.jl](https://github.com/ZacLN/CSTParser.jl) under the hood.
99

10+
## Running FemtoCleaner locally
11+
12+
It is possible to run FemtoCleaner locally (to fix, for example, deprecations in a private repository).
13+
14+
Install `FemtoCleaner` (currently working on Julia v0.6.x only https://julialang.org/downloads/oldreleases.html ) using
15+
16+
```jl
17+
Pkg.clone("https://github.com/Keno/AbstractTrees.jl")
18+
Pkg.checkout("AbstractTrees.jl","kf/for06")
19+
Pkg.clone("https://github.com/JuliaComputing/Deprecations.jl")
20+
Pkg.clone("https://github.com/JuliaComputing/FemtoCleaner.jl")
21+
using FemtoCleaner
22+
```
23+
24+
A repository of Julia code can be cleaned using
25+
26+
```jl
27+
using FemtoCleaner
28+
FemtoCleaner.cleanrepo(path::String, show_diff = true, delete_local = true)
29+
```
30+
For example on Windows:
31+
```jl
32+
using FemtoCleaner
33+
FemtoCleaner.cleanrepo("C:\\repositoryFolder", show_diff = true, delete_local = true)
34+
```
35+
36+
This clones the repo located at `path`, which can be a file system path or a URL, to a temporary directory
37+
and fix the deprecations. If `show_diff` is `true`, the diff from applying the deprecations is showed.
38+
If `delete_local` is `true` the cleaned repo, is deleted when the function is finished.
39+
1040
# User Manual
1141

12-
To set up FemtoCleaner on your repository, go to https://github.com/integration/femtocleaner and click "Configure" to select the repositories you wish to add.
42+
To set up FemtoCleaner on your repository, go to https://github.com/apps/femtocleaner and click "Configure" to select the repositories you wish to add.
1343

1444
## Invoking FemtoCleaner
1545

@@ -64,35 +94,6 @@ publicly hosted version thereof. In particular:
6494

6595
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
6696
67-
## Running FemtoCleaner locally
68-
69-
It is possible to run FemtoCleaner locally (to fix, for example, deprecations in a private repository).
70-
71-
Install `FemtoCleaner` (currently working on Julia v0.6.x only https://julialang.org/downloads/oldreleases.html ) using
72-
73-
```jl
74-
Pkg.clone("https://github.com/Keno/AbstractTrees.jl")
75-
Pkg.checkout("AbstractTrees.jl","kf/for06")
76-
Pkg.clone("https://github.com/JuliaComputing/Deprecations.jl")
77-
Pkg.clone("https://github.com/JuliaComputing/FemtoCleaner.jl")
78-
using FemtoCleaner
79-
```
80-
81-
A repository of Julia code can be cleaned using
82-
83-
```jl
84-
using FemtoCleaner
85-
FemtoCleaner.cleanrepo(path::String, show_diff = true, delete_local = true)
86-
```
87-
For example on Windows:
88-
```jl
89-
using FemtoCleaner
90-
FemtoCleaner.cleanrepo("C:\\repositoryFolder", show_diff = true, delete_local = true)
91-
```
92-
93-
This clones the repo located at `path`, which can be a file system path or a URL, to a temporary directory
94-
and fix the deprecations. If `show_diff` is `true`, the diff from applying the deprecations is showed.
95-
If `delete_local` is `true` the cleaned repo, is deleted when the function is finished.
9697

9798
# Developer Manual
9899

0 commit comments

Comments
 (0)