Add README

ChangeLog

@@ -6,6 +6,7 @@
 	* Fix locked files during tests
 	* Add a makefile recipe for generating documentation
 	* Add a smart cache feature
+	* Add README
 
 2024-05-03 Konstantin Kushnir <[email protected]>
 	* Fix missed quotes in pages.test

README.md

@@ -1 +1,44 @@
 # cookfs
+
+## About
+
+Cookfs is a Tcl virtual filesystem using a compressed archive format to allow embedding multiple files in an archive that Tcl scripts can access directly.
+
+It is optimized for storing Tcl packages (allowing around 10%-20% smaller sizes ratio than mk4vfs while still using zlib compression), small, fast and integrated with Tcl.
+
+It is designed only for use as Tcl VFS and provides multiple optimizations especially for delivering Tcl based standalone applications.
+
+## Compatibility
+
+This package requires [tclvfs](https://core.tcl-lang.org/tclvfs/index) and Tcl 8.5 or later, however it has only been tested with Tcl 8.6.14.
+
+## Built packages and sources
+
+The source code is available on [Github](https://github.com/chpock/cookfs).
+
+Built packages are available on the above Github page, under [Releases](https://github.com/chpock/cookfs/releases).
+
+There are packages for the following platforms:
+
+- **Windows x86** and **x86\_64**: Windows XP or higher is required. However, they are only tested on Windows 10.
+- **Linux x86** and **x86\_64**: built and tested on Cenos6.10. Require glibc v2.12 or higher.
+- **MacOS x86** and **x86\_64**: built and tested on MacOS 10.12. However, these packages should be compatible with MacOS as of version 10.6.
+
+## Copyrights
+
+Copyright (c) 2010-2011 Wojciech Kocjan, Pawel Salawa
+Copyright (C) 2024 Konstantin Kushnir <[email protected]>
+
+## License
+
+This code is licensed under the same terms as the Tcl Core.
+
+This package contains bzip2 source code, which is copyright Julian R Seward.
+
+License for bzip2 is contained in file "bzip2/LICENSE" and applies to all
+files under bzip2/ subdirectory.
+
+This package contains LZMA SDK, which is under the public domain.
+
+License for LZMA SDK is contained in file "7zip/DOC/License.txt" and applies to all
+files under 7zip/ subdirectory.

license.terms

@@ -1,11 +1,18 @@
-NOTE:
+NOTES:
+
 This package contains bzip2 source code, which is copyright Julian R Seward.
 License for bzip2 is contained in file "bzip2/LICENSE" and applies to all
 files under bzip2/ subdirectory.
 
+This package contains LZMA SDK, which is under the public domain.
+License for LZMA SDK is contained in file "7zip/DOC/License.txt" and applies to all
+files under 7zip/ subdirectory.
+
 --------------------------------------------------------------------------
 
-This software is copyrighted by Pawel Salawa.
+This software is copyrighted by:
+    (c) 2010-2011 Wojciech Kocjan, Pawel Salawa
+    (C) 2024 Konstantin Kushnir <[email protected]>
 
 The following terms apply to all files associated with the
 software unless explicitly disclaimed in individual files.
@@ -35,12 +42,12 @@ MODIFICATIONS.
 
 GOVERNMENT USE: If you are acquiring this software on behalf of the
 U.S. government, the Government shall have only "Restricted Rights"
-in the software and related documentation as defined in the Federal 
+in the software and related documentation as defined in the Federal
 Acquisition Regulations (FARs) in Clause 52.227.19 (c) (2).  If you
 are acquiring the software on behalf of the Department of Defense, the
 software shall be classified as "Commercial Computer Software" and the
 Government shall have only "Restricted Rights" as defined in Clause
 252.227-7013 (c) (1) of DFARs.  Notwithstanding the foregoing, the
 authors grant the U.S. Government and others acting in its behalf
 permission to use and distribute the software in accordance with the
-terms specified in this license. 
+terms specified in this license.