forked from wimpysworld/deb-get
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Move pertinent documentation to 01-main subfolder
- Loading branch information
1 parent
d2f1755
commit 1c157c4
Showing
5 changed files
with
264 additions
and
252 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Adding Software | ||
## What is acceptable? | ||
This defines what software can be added to the main repository, and therefore the scope of the project in terms of what it is intended for: | ||
* Software **has to be published as a `.deb`**. Build from source, tarballs or other binary releases will not be accepted. | ||
* Software **has to be published authoritatively by the upstream vendor, project or maintainer**. Packages published by unassociated community contributors will not be accepted. | ||
* Software **must be actively maintained**. | ||
* **Only stable/production releases**. Daily/nightly, betas or pre-release versions will not be accepted. | ||
* GitHub Releases and direct downloads **must have a reliable means to dynamically determine the current upstream published version**. Hardcoded versions will be not accepted. | ||
* **Packages that install directly from the official Debian or Ubuntu apt archives will not be accepted**. | ||
* **Packages that replace components in the hardware enablement stack (HWE) such as the Linux kernel and Mesa will not be accepted**. | ||
|
||
If you found a package that fits the criteria above, have checked that it does not already have a pending request and has not previously been declined, please [open an issue](../../../issues/new) following the template for requesting a new app. | ||
|
||
## Creating the package definition file | ||
**Before [opening a pull request](../../../pulls) to add a new package, make sure an [issue is already open](../../../issues) for it**. **This helps keep things organized**. | ||
|
||
**Before submitting a PR, do not forget to [update README.md](#updating-readmemd)**. | ||
|
||
For information on how to create a package definition file, head to [EXTREPO](../EXTREPO.md#the-package-definition-files). | ||
|
||
# Updating README.md | ||
**This needs to be done every time a package is added or removed, or the details of a package are changed**. | ||
|
||
To update `README.md`, first install [cog](https://pypi.org/project/cogapp): | ||
```bash | ||
sudo pip3 install cogapp | ||
``` | ||
|
||
Then run: | ||
```bash | ||
cog -r README.md | ||
``` |
Oops, something went wrong.