Skip to content

Commit a210dd5

Browse files
committed
Update readme
1 parent 89d2894 commit a210dd5

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,17 @@
77
## Installation
88
This assumes that PHP and Composer is already installed. This also assumes that the Composer's bin is already added to your path (Add `export PATH=~/.composer/vendor/bin:$PATH` to your `.zshrc` ). To install the command do:
99
- Open the terminal and run `composer global require webteractive/devstack`. This will install a CLI command `devstack`.
10-
- Set the configuration by running `devstack config`. This command will ask the `repository`, `branch`, and `token`.
11-
- Once the configuration is set, you can now initialize the EN runtimes. Just run `devstack init <runtime>`. The `<runtime>` can be `aac`, `eepower`, and `control` so to load up AllAboutCircuits runtime, all you have to do is do `devstack init aac`.
12-
- Add `.zshrc` or `.bash_profile` `alias dev="bash dev"` to freely use the `dev` cli.
10+
- Running the `devstack` command should list all available commands that you can use.
11+
12+
13+
# Initializing Runtimes
14+
There are to ways to initialize runtimes.
15+
1. By running `devstack https://github.com/vendor/the-name-of-the-runtime`.
16+
2. By using a private repository. This good for runtimes that you don't want to share to the world.
17+
18+
## Using Private Runtimes
19+
You can do this by following the steps below:
20+
1. Run the `devstack config` command, this will ask the repository url, the branch, and token. The token here is your personal access token. Visit [this](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) page for more details on how to obtaine one.
21+
2. Once the configuration is done, you may now initialize runtimes from your private repository by doing `devstack init the_runtime_name`.
22+
3. To download the latest runtimes in your repository, run `devstack download`.
1323

0 commit comments

Comments
 (0)