Skip to content

Commit e0bc454

Browse files
committed
Add demo gif
1 parent 894fc5a commit e0bc454

File tree

2 files changed

+17
-18
lines changed

2 files changed

+17
-18
lines changed

README.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,36 @@ Browse your code in peace.
44

55
Fly around in 3D and browse a directory tree.
66

7-
**From the repo root:**
7+
![](example-file-browser.gif)
88

9-
Install: `npm i && npm i -g serve`
9+
## Running
1010

11-
List directory: `./scripts/list-directory.js example`
11+
### From the repo root -
1212

13-
Run: `serve -s -l 5001`
13+
Install package and http server: `npm i && npm i -g serve`
1414

15-
- Text, Markdown, Code, Image (JPG, PNG) support
16-
- VR support!?
17-
- File formats:
18-
- Images (`.jpg`, `.png`)
19-
- Text (`.txt`, `.md`)
20-
- Code (`.cpp`, `.c`, `.h`)
15+
Create directory listing file: `./scripts/list-directory.js example/`
2116

22-
## Usage
17+
Run: `serve -s -l 5001`; navigate to `localhost:5001` to view.
2318

24-
Navigate to `localhost:5001` to view
19+
The default example runs using the files in `example/`. Run `./scripts/clone-and-list.js` to setup other repos for viewing in `scripts/output/cloned-repos/`.
2520

26-
Running the default example uses `example/`. Run the `clone-and-list` script to fetch to your default workspace, `scripts/output/cloned-repos/`.
21+
### Supports -
2722

28-
## TODO
23+
- Images (`.jpg`, `.png`)
24+
- Text (`.txt`, `.md`)
25+
- Code (`.cpp`, `.c`, `.h`)
2926

30-
- [ ] Support many file & mime types (SVG, MP4)
27+
## Future Features
28+
29+
- [ ] More file & MIME types (`.svg`, `.mp4`)
3130
- [ ] `q`, `e` for flying `upward`, `downward`
32-
- [ ] Succinct 3D model for a `directory`, and default `file`
31+
- [ ] Clear 3D default models for directories and files
3332
- [ ] Handlable UI (Focus, Move)
3433
- [ ] Collapsible directories
3534
- [ ] Secondary edges for file hyperlinks
36-
- [ ] Canvas image rendering option
3735
- [ ] Documentation generator support (Doxygen, JSDoc)
38-
- [ ] HTML5 filesystem support (`bro-fs`) for temporary cloned repos
36+
- [ ] HTML5 filesystem support (`bro-fs`), for temporary cloned repos
3937
- [ ] Support for VR devices
38+
- [ ] Canvas-based image rendering option
4039
- [ ] 2D analog

example-file-browser.gif

1.86 MB
Loading

0 commit comments

Comments
 (0)