1
0
mirror of https://github.com/uutils/coreutils synced 2024-07-03 07:58:37 +00:00
coreutils/README.md

149 lines
2.7 KiB
Markdown
Raw Normal View History

2014-06-12 13:48:41 +00:00
uutils coreutils [![Build Status](https://api.travis-ci.org/uutils/coreutils.svg?branch=master)](https://travis-ci.org/uutils/coreutils)
2013-08-02 17:24:20 +00:00
================
uutils is an attempt at writing universal (as in cross-platform) CLI
utils in [Rust](http://rust-lang.org). This repo is to aggregate the GNU
coreutils rewrites.
Why?
----
2014-02-19 01:52:47 +00:00
Many GNU, Linux and other utils are pretty awesome, and obviously
2013-08-02 17:24:20 +00:00
[some](http://gnuwin32.sourceforge.net) [effort](http://unxutils.sourceforge.net)
2014-02-19 01:52:47 +00:00
has been spent in the past to port them to Windows. However, those projects
2014-02-06 05:18:03 +00:00
are either old, abandoned, hosted on CVS, written in platform-specific C, etc.
2013-08-02 17:24:20 +00:00
2014-02-19 01:52:47 +00:00
Rust provides a good, platform-agnostic way of writing systems utils that are easy
2013-08-02 17:24:20 +00:00
to compile anywhere, and this is as good a way as any to try and learn it.
Build Instructions
------------------
To simply build all available utilities:
```
make
```
To build all but a few of the available utilities:
```
make DONT_BUILD='UTILITY_1 UTILITY_2'
```
To build only a few of the available utilities:
```
make BUILD='UTILITY_1 UTILITY_2'
```
Test Instructions
-----------------
To simply test all available utilities:
```
make test
```
To test all but a few of the available utilities:
```
make DONT_TEST='UTILITY_1 UTILITY_2' test
```
To test only a few of the available utilities:
```
make TEST='UTILITY_1 UTILITY_2' test
```
2013-11-30 23:07:22 +00:00
Contribute
----------
Contributions are very welcome, and should target Rust's master branch until
Rust 1.0 is released. You may *claim* an item on the to-do list by following
2013-12-15 19:04:49 +00:00
these steps:
2013-11-30 23:07:22 +00:00
1. Open an issue named "Implement [the utility of your choice]", e.g. "Implement ls"
2. State that you are working on this utility.
3. Develop the utility.
4. Submit a pull request and close the issue. Your pull request should include deleting the utility from the to-do list on this README.
The steps above imply that, before starting to work on a utility, you should search the issues to make sure no one else is working on it.
2013-08-02 17:24:20 +00:00
To do
-----
- chcon
- chgrp
- chmod
- chown-core
- chown
- chroot
- copy
- cp-hash
- csplit
- cut
- date
- dd
- df
- dircolors
2014-03-09 06:38:47 +00:00
- expand (in progress)
2013-08-02 17:24:20 +00:00
- expr
- extent-scan
- find-mount-point
- fmt
- getlimits
- group-list
- install
- join
- lbracket
- libstdbuf
- link
- ln
- ls-dir
- ls-ls
- ls-vdir
- ls
- mkfifo
- mknod
- mktemp
- mv
- nice
- nl
- nohup
- nproc
- numfmt
- od
- operand2sig
- pathchk
- pinky
- pr
- printf
- prog-fprintf
- ptx
- readlink
- realpath
- relpath
- remove
- runcon
- setuidgid
- shred
- shuf
- sort
- split
- stat
- stdbuf
2014-03-02 01:21:15 +00:00
- stty (in progress)
2013-08-02 17:24:20 +00:00
- sync
- tac-pipe
- tail
- test
- timeout
- tsort
- uname-arch
- uname-uname
- unexpand
2013-11-29 19:40:54 +00:00
- uniq (in progress)
2013-08-02 17:24:20 +00:00
- who
License
-------
uutils is licensed under the MIT License - see the `LICENSE` file for details