Skip to content

Commit

Permalink
Adding emojis and screenshots so people will think this is cool 😅
Browse files Browse the repository at this point in the history
  • Loading branch information
robo-corg committed Aug 25, 2024
1 parent 6b141be commit 21a24d6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# Porgi
# Porgi 🐾

A ~~tool~~ corgi to organize and find projects, a porgi.
A corgi to organize and find your projects, a porgi.

Probably don't use this yet since its very much a WIP.

![obligatory screen shot of porgi in action as it snappily loads projects and lets the user view readme files.](docs/obligatory_screenshot.gif "It is a fast porgi 🐶")

If you are like me you probably have some directory on computer brimming with hopes, dreams, and build files called "projects". If you often find yourself scratching your head and forgetting where put that very important weird cli tool that you now can't live with out (perhaps because you name everything corgi) this tool is for you.

## Configuring your porgi

*Porgi require a config file to run for now*

Add the following to `~/.config/porgi/porgi.toml`

```toml
Expand All @@ -22,6 +28,17 @@ project_dirs = ["~/projects"]
opener = "auto"
```

## Features

- [x] Multiple project directories
- [x] Sort projects by most recent changes
- [ ] Open in editor (WIP)
- [ ] New user onboarding (TBD if this will be in TUI)
- [ ] Preview of file tree
- [ ] Stats for project such as file count, lines of code etc...
- [ ] Cleaning old build files and projects
- [ ] Checking projects are up to date in git

## Other project finding tools

[projects-cli](https://github.com/webdesserts/projects-cli/tree/master)
Binary file added docs/obligatory_screenshot.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 21a24d6

Please sign in to comment.