Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yatima1460 committed May 3, 2019
1 parent f6f08cd commit 877f20f
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,30 @@ Search files without using indexing, but clever crawling:

![](https://raw.githubusercontent.com/yatima1460/drill/assets/screenshot.png)

## Fast guide
## How to run this

**Use the provided AppImage, just double click it**

If your distro doesn't ask you to mark it executable or nothing happens try:
- `chmod +x Drill.AppImage`
- `./Drill.AppImage`

## UI Guide
```
Double click = open
Right click = open containing folder
Return/Enter = open
Middle Click = messagebox with file info (TODO)
```

## Manual prerequisites
## Manual prerequisites using Python

- Python 3 needed
- `sudo apt install python3-tk` (you should already have it)
- `python3 setup.py install --user`


### Run
### Run manually with Python 3
```
python3 drill.py
```
Expand All @@ -39,14 +46,6 @@ chmod +x drill.py
./drill.py
```

## Guide
```
Double click = open
Right click = open containing folder
Return/Enter = open
Middle Click = messagebox with file info (TODO)
```

## What is this

I was stressed on Linux because I couldn't find the files I needed, file searchers based on system indexing (updatedb) are prone to breaking and hard to configure for the average user, so did an all nighter and started this.
Expand Down

0 comments on commit 877f20f

Please sign in to comment.