Skip to content

Commit

Permalink
add Github Codespaces section
Browse files Browse the repository at this point in the history
  • Loading branch information
MohitYadav-codes committed Apr 15, 2024
1 parent 8b01d99 commit fb55a10
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,33 @@ A DevContainer, or Development Container, is a reproducible development environm

6. The `postCreateCommand` will run `poetry install` automatically to prepare the enviornment.

## Setup and Use with GitHub Codespaces

1. Navigate to the main page of the repository on GitHub.

2. Click the 'Code' button and then click 'Open with Codespaces'.

![Open with Codespaces](https://docs.github.com/assets/images/help/repository/code-button.png)

3. Click on '+ New codespace'.

![New codespace](https://docs.github.com/assets/images/help/codespaces/new-codespace-button.png)

4. GitHub will create a new Codespace and automatically start setting it up by using the settings defined in the `.devcontainer/devcontainer.json` file in the repository. This includes installing any necessary extensions, setting up the correct runtime environment, and running any postCreateCommand defined.

5. Once the Codespace is ready, you can start working with the code. You can run the module with Poetry:

```
poetry run akm_tools/akm_parser.py
```

6. Or with Poetry shell enabled. (normally your terminal prompt will be prefixed with it)

```
python akm_tools/akm_parser.py
```

Remember, any changes you make in the Codespace will be on its own separate branch, so you can commit and push your changes as you would normally with Git. When you're done, you can close the Codespace to stop incurring charges, and your code will be there when you come back.


Refer to [akm_tools/README.MD](akm_tools/README.md) for instructions on how to use the tools.

0 comments on commit fb55a10

Please sign in to comment.