Skip to content

Commit b46b2f4

Browse files
committed
Add README.rst
1 parent e020511 commit b46b2f4

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
===============
2+
python-userland
3+
===============
4+
5+
python-userland is a cross-platform implementation of various UNIX and Linux
6+
utilities, written purely in Python 3. It aims to eventually achieve feature
7+
parity with well-known projects such as GNU coreutils.
8+
9+
Source files are located under the `src/`; for portability, each of them is a
10+
standalone Python executable that relies only on a Python interpreter and
11+
standard library. No third-party libraries are (currently) used.
12+
13+
Note that this project is a work-in-progress. Not many utilities have been
14+
finished, and existing utilities may be limited in functionality, performance
15+
and correctness.
16+
17+
Compatibility with Other Implementations
18+
========================================
19+
20+
Currently undecided.
21+
22+
Platform Support
23+
================
24+
25+
python-userland should, in principle, run on any OS that runs Python. However,
26+
much testing has only been done in a Linux environment. This will hopefully
27+
change in the future.
28+
29+
License
30+
=======
31+
32+
python-userland is licensed under the GPL. See the LICENSE file for more
33+
information.

0 commit comments

Comments
 (0)