# DevContainerExample

**Repository Path**: panbingwen/DevContainerExample

## Basic Information

- **Project Name**: DevContainerExample
- **Description**: DevContainerExample
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2024-04-08
- **Last Updated**: 2024-04-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# DevContainerExample

## 介绍

DevContainerExample 是一个可供SuperIDE使用的C语言开发环境容器的范例项目。

[直接指定容器镜像作为开发环境的hello world范例项目](https://gitee.com/SuperIDE/DevContainerExample/releases/tag/v1.0)

[基于Dockerfile定义开发环境容器的hello world范例项目](https://gitee.com/SuperIDE/DevContainerExample/releases/tag/v2.0)

## 使用说明

1.  安装Docker，https://www.docker.com/products/docker-desktop/
2.  安装Git， https://git-scm.com/download
3.  安装VS Code, https://code.visualstudio.com/

   * 3.1. 安装Dev Container插件

4. 在VS Code中打开DevContainerExample项目，然后点击左下角远程开发，选择在容器中重新打开；或者选择在容器中打开文件夹。

这时即可使用环境容器中的开发工具, 在终端中执行：

```
make
./hello
make clean
```

也可使用vscode定义的task执行既定任务（任务定义在`.vscode/tasks.json`中）:

- 快捷键`Ctrl + Shift + P`打开命令面板输入`task`
- 在列出的命令中选择想要执行的命令

## 开发环境容器镜像制作指南

如果你想制作符合SuperIDE使用标准的开发环境容器镜像，请参考本项目目录下的`.devcontainer/开发环境容器镜像制作指南.md`文档

## SuperIDE容器镜像标准

### 开发环境容器镜像目录

- /workspace

  - project	工作时项目目录的挂载文件夹，也是容器默认工作目录

  - ExampleProject	示例项目目录，初始化空文件夹时从该目录拷贝初始化项目

### 项目工作目录结构

- .vsocde
  - tasks.json	保存工具链执行命令，toolchain根据这些命令执行对应操作
- SuperIDE.ini	项目配置文件
- 其余文件夹

## License

Copyright (c) 2024-present Mengning <mengning997@163.com>

DevContainerExample is licensed under Mulan PSL v2.