diff --git a/README.md b/README.md index 7326bb96f15a189d20d2905dadceb498d10f710e..6970844eaf90ffe6e0ae3ead01f16599dafe1917 100644 --- a/README.md +++ b/README.md @@ -29,4 +29,14 @@ A collection of software ports for Redox. In order for this repository to be useful, it must be set up with an environment from the [redox](https://gitlab.redox-os.org/redox-os/redox) repository. +### Package Policy + +When you send your recipe to upstream (to become a public package), you must follow these rules: + +- Keep the static linking of libraries, there's an exception if the library/runtime is bigger than 50MB, big libraries/runtimes like LLVM can be dynamically linked. +- Respect the ABI separation of the packages, for example, if `openssl1` is available and some program need `openssl3`, you will create a recipe for `openssl3` and not rename the `openssl1`, as it will break the ABI of the dependent packages. +- If your recipe download a tarball you need to create a BLAKE3 hash for it, you can learn how to do it [here](https://doc.redox-os.org/book/ch09-03-porting-applications.html#create-a-blake3-hash-for-your-recipee). +- Verify if the recipe has some license violation, in case of doubt ask us on the [chat](https://doc.redox-os.org/book/ch13-01-chat.html). +- If your recipe is incomplete you will add it on the `wip` folder, you don't need to insert a BLAKE3 hash (it's quicker to test new tarball versions without checksum) but you need to insert a `#TODO` on the beginning of the `recipe.toml` and explain what's missing. Once the recipe is ready, add the BLAKE3 hash if needed and move the folder to the appropriate category. + [](./LICENSE) \ No newline at end of file