diff options
| -rw-r--r-- | README.rst | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..4af40a9 --- /dev/null +++ b/README.rst @@ -0,0 +1,77 @@ +========= + APK Kit +========= +:Authors: + * **Andrew Wilcox** +:Version: + 1.0 +:Status: + Alpha +:Copyright: + © 2015 Wilcox Technologies LLC. NCSA open source licence. + + + +Requirements +============ + +Background +---------- +Our new Linux distro (codename Adélie) combines pieces of Portage, a stable +Python-based package build system, with the AlpineLinux package format, APK. We +need a pure Python library for manipulating and verifying APK packages. We also +need a pure Python library for maintaining APK repositories. + + +Objectives / success critera +---------------------------- +* Compatibility with upstream APK Tools. +* Stable v1 release by October 2015. +* Minimal to no external dependencies. + + + + +Solution vision +=============== + +Major features +-------------- +#. Pull metadata out of an APK file. + +#. Sanity check APK files and repositories. + +#. Creation of APK files. + +#. Keep repository INDEX files up to date. + + + + +Project Scope and Limitations +============================= + +Scope of initial release (v1) +----------------------------- +The initial release will focus primarily on the handling of APK files. Some +limited repository functionality may be present to further the ends of APK file +management. + + +Scope of next release (v2) +-------------------------- +The second release will focus further on repository management. + + +Scope of future releases +------------------------ +Further releases will focus on keeping up to date with the upstream APK format, +and stability and performance fixes. No further major features are anticipated. + + +Limitations and exclusions +-------------------------- +.. warning:: This is **NOT** meant to be used by end users, or as a replacement + package manager! It is designed for manipulation of APK packages, not + existing APK databases. It probably has very little use unless you are a + package or repository maintainer. |