Skip to content

Readme Updates #97

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.

Sign up for GitHub

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

Merged
ReeseHatfield merged 4 commits into from
Sep 2, 2026
Merged

Readme Updates #97

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc03b7a
example slide image
ReeseHatfield Sep 2, 2026
0228b6b
document user.name must be configured
ReeseHatfield Sep 2, 2026
5093588
add example to readme
ReeseHatfield Sep 2, 2026
39598ae
better document license in readme
ReeseHatfield Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,20 @@ The CLI tool designed to help you scaffold, manage, and deploy your OSEDA projec

---

## Installation
<br>
<p align="center">
<img src="img/example.png" width=600>
</p>
<p align="center">
An example OSEDA presentation slide
<br>
</p>


## Installation:

To install `oseda-cli`, make sure you have **Cargo** and **NPM** installed.
Additionally, if you are deploying your project to [oseda.net](https://www.oseda.net), please ensure that you are signed in with Github and your `git config --global user.name` is configured correctly

### Prefered installation

Expand Down Expand Up @@ -103,9 +114,10 @@ Feel free to submit a PR to this, or any other Oseda repository.

---

## License
## Licensing

This project is licensed under the MIT License.
If you are deploying a project to [oseda.net](https://www.oseda.net), your project *must* be licensed under a [popular, community forward license](https://opensource.org/Licenses?categories=popular-strong-community) recognized by the Open Source Initiative

---

Expand Down
Binary file added img/example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading