Skip to content

Commit 879322e

Browse files
committed
Add a simple readme
1 parent bec0c1c commit 879322e

File tree

1 file changed

+42
-0
lines changed

1 file changed

+42
-0
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Puppyutils
2+
3+
An efficient and correct implementation of coreutils, util-linux and other core
4+
Linux system utilities in Rust.
5+
6+
## Features
7+
8+
- **Compact**: Optimized for minimal binary size and memory footprint
9+
- **Memory Safe**: Built with Rust to prevent common security vulnerabilities
10+
- **Fast**: Efficient implementations that outperform traditional utilities
11+
12+
<!-- - **Drop-in Replacement**: 99% compatible with existing scripts and workflows -->
13+
14+
## Installation
15+
16+
### Building from Source
17+
18+
```bash
19+
git clone https://github.com/puppyutils/puppyutils
20+
cd puppyutils
21+
./build-release.sh
22+
```
23+
24+
## Available Utilities
25+
26+
- **`true`** - Exit with success status
27+
- **`false`** - Exit with failure status
28+
- **`uname`** - Display system information
29+
- **`whoami`** - Display current username
30+
- **`yes`** - Output strings repeatedly
31+
- **`ls`** - List directory contents (in development)
32+
33+
All utilities support `--help` and `--version` flags.
34+
35+
## Contributing
36+
37+
See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on contributing to the
38+
project.
39+
40+
## License
41+
42+
TBA

0 commit comments

Comments
 (0)