summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorNamilskyy <alive6863@gmail.com>2025-11-25 16:05:43 +0300
committerNamilskyy <alive6863@gmail.com>2025-11-25 16:05:43 +0300
commitf8a09b720ccca6fbd5ed748bdbb5377fc67fb566 (patch)
treebf2f030d38eecf01df49420e788beece66d03020 /README.md
parent532e612c54a526cd219e65da2e4083e79ee5217b (diff)
Added more info about plans to mesk in README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 28 insertions, 2 deletions
diff --git a/README.md b/README.md
index fd5ebbd..a0c7eba 100644
--- a/README.md
+++ b/README.md
@@ -2,5 +2,31 @@
**Mesk is a source-based package manager based on i2p protocols, tailored for independence and the absence of spyware.**
**Powered by I2P.**
-> [!WARNING]
-> In work now, no release build.
+# Package Structure
+`.mesk` - **is a compressed gzip tarball containing information on how to build, configure and install it**.
+
+```
+# Example file-tree of package.mesk
+.
+├── BUILD
+├── INSTALL
+├── LICENSE
+├── Makefile
+├── SETTS
+└── src
+ ├── some_code.c
+ └── some_code.rs
+
+```
+
+- **BUILD:** Not required if the package does not require compilation/other assembly
+- **INSTALL:** Where or how to install the package? For example, you can just leave make install and the package will be installed by make, not mesk.
+- **SETTS:** What needs to be configured after installation? For example, install basic configurations (if this is not done in `INSTALL`) or export environment variables.
+
+
+**Binary packages are also supported, but the default installation is source-based.**
+You can set the package compilation parameters in the global /etc/mesk.toml. (Read more in the documentation.) For example, the compiler, optimization level settings, etc. Here we are similar to portage.
+
+The '.mesk` package can be generated automatically, given that the software is open source and based on standard build systems: `make`, `CMake`, `meson`, `cargo`. If the package does not require compilation, you must specify how and where to install it.
+
+We only support open source software. Binary builds of proprietary applications will not appear in the official repositories, but, for example, there will be open clients for messengers with a closed backend. \ No newline at end of file