-
Notifications
You must be signed in to change notification settings - Fork 214
Added README with local development instructions #1363
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
Sau1707
wants to merge
1
commit into
pop-os:master
Choose a base branch
from
Sau1707:master
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,40 @@ | ||
| # COSMIC Applets Development | ||
|
|
||
| This repository is a Rust workspace for COSMIC panel applets and panel buttons. | ||
|
|
||
| ## Install Build Dependencies | ||
|
|
||
| On Debian or Ubuntu | ||
|
|
||
| ```bash | ||
| sudo apt build-dep . | ||
| ``` | ||
|
|
||
| ## Getting Started | ||
|
|
||
|
|
||
| A [justfile](./justfile) is included by default with common recipes used by other COSMIC projects. Install from [casey/just][just] | ||
|
|
||
| - `just` builds the application with the default `just build-release` recipe | ||
| - `sudo just install` installs the project into the system | ||
| - `just vendor` creates a vendored tarball | ||
| - `just build-vendored` compiles with vendored dependencies from that tarball | ||
| - `just check` runs clippy on the project to check for linter warnings | ||
| - `just check-json` can be used by IDEs that support LSP | ||
|
|
||
|
|
||
| ## Reload The Current Applets | ||
|
|
||
| After installing a new build, restart the panel so COSMIC relaunches the applets: | ||
|
|
||
| ```bash | ||
| systemctl --user restart cosmic-session.target | ||
| pkill cosmic-panel | ||
| ``` | ||
|
|
||
| You can also restore the packaged version by reinstalling the distro package: | ||
|
|
||
| ```bash | ||
| sudo apt install --reinstall cosmic-applets | ||
| pkill cosmic-panel | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's better to use
mk-build-depsfor easy future uninstallation.