Skip to content

Commit 6b3a507

Browse files
authored
Update README
1 parent 4c0f080 commit 6b3a507

1 file changed

Lines changed: 36 additions & 0 deletions

File tree

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
11
# FileCmd
22
A cross-platform command shell intended for file management.
3+
4+
# Installation
5+
6+
<details>
7+
<summary>Windows</summary>
8+
Download the executable binary from the <a href="https://github.com/fireblade211/filecmd/releases">Releases</a> page and run it.
9+
</details>
10+
<details>
11+
<summary>macOS</summary>
12+
See the <a href="#building">Building</a> section for more info. Precompiled DMG files aren't provided for macOS (mainly because I don't own a mac lol)
13+
</details>
14+
<details>
15+
<summary>Linux (Debian)</summary>
16+
17+
Download the <B>.DEB</B> file from the <a href="https://github.com/fireblade211/filecmd/releases">Releases</a> page, run it and click <B>Install Package</B>. You can then open the terminal and run by typing:
18+
```sh
19+
./FileCmd
20+
```
21+
Or, to run elevated:
22+
```sh
23+
sudo ./FileCmd
24+
```
25+
</details>
26+
27+
# Building
28+
Clone the repository:
29+
```pwsh
30+
git clone https://github.com/FireBlade211/FileCmd.git
31+
```
32+
Then, open the [FileCmd.slnx](src/FileCmd.slnx) file in **Visual Studio** and click the **Run** button.
33+
34+
# Getting Started
35+
When **FileCmd** starts, you can type the **cmdlist** command to view a list of the commands. The command will also tell you how to access help for the other commands.
36+
```fcmd
37+
cmdlist
38+
```

0 commit comments

Comments
 (0)