Skip to content

Update README.md #6

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
merged 2 commits into from
Sep 3, 2022
Merged

Update README.md #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d8845a
Update README.md
ChristophLHR Sep 3, 2022
9522261
Change 2. Library Name
ChristophLHR Sep 3, 2022
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,3 +38,22 @@ Shows all available configurations.
## help
Shows all available commands and their description.
- `<name>`: Shows the description of a command by name.

## Requires
If you want to load a library within a program and keep it updated through SCM, then you can do that with the following notation:

```lua
local scm = require("./scm")
scm:load("testLibrary")
```

If the Library is already called by a Programm using this SCM loader, SCM will check all Libraries loaded for these comments:


```lua
--@requires subLibrary
require("subLibrary")
```

The comment tells SCM to look for the sub-library and, if it's not already installed, it will try to download it.
This prevent the programm from Crashing, should SCM not be installed.