Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
Sunrisepeak committed Sep 23, 2024
1 parent 8438f4a commit b1b2853
Show file tree
Hide file tree
Showing 10 changed files with 278 additions and 15 deletions.
42 changes: 29 additions & 13 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,47 @@
# Summary

- [简介]()

# 通用

- [xxx]()
- [简介](./chapter_0.md)

# xlings
---

- [xxx]()
# xlings项目

# d2ds
- [0.简介](./xlings/chapter_0.md)
- [1.快速安装](./xlings/chapter_1.md)
- [2.常用命令功能](./xlings/chapter_2.md)
- [2.1.环境配置和软件安装 - install]()
- [2.2.代码动态编译和运行 - run]()
- [2.3.项目管理 - drepo](./xlings/chapter_2_3.md)
- [3.项目搭建](./xlings/chapter_3.md)
- [3.1.快速开始](./xlings/chapter_3_1.md)
- [3.2.AI大模型和配置文件]()
- [4.添加新项目到drepo]()

- [1.useage模块开发](./d2ds/chapter_0.md)
---

# d2cpp
# d2ds项目

- [xxx]()
- [0.简介](./d2ds/chapter_0.md)
- [1.useage模块开发](./d2ds/chapter_1.md)

# d2python

- [xxx]()
---

# xlings-book-template
# xlings-book-template项目

- [1.快速使用](./book-template/chapter_0.md)
- [1.1.创建文档仓库](./book-template/chapter_1.md)
- [1.2.配置并更新内容](./book-template/chapter_2.md)

- [2.反馈&交流](./book-template/chapter_3.md)

---

# d2cpp

- [xxx]()

# d2python

- [xxx]()
8 changes: 8 additions & 0 deletions book/src/chapter_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# d2learn社区

一个技术知识分享、学习、交流的开源社区

**反馈 & 交流**

- [d2learn社区论坛](https://github.com/orgs/d2learn/discussions)
- 即时交流群(Q): 167535744
13 changes: 11 additions & 2 deletions book/src/d2ds/chapter_0.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# useage模块开发文档
# 动手写数据结构 | d2ds - WIP

...
Dive into Data Structures - 强调**动手实践****数据结构**学习项目,其中包含**在线书籍、公开课、练习代码**等子项目


## 目标

- **1.** 任何人都可以在网上**免费获取**
- **2.** 不仅强调原理, 更**强调动手实践**
- **3.** **自动化的代码练习系统**, 让使用者轻松**从零实现一个数据结构**
- **4.** **强调共建共享**, 让更多的人加入d2ds社区, 快速迭代和提升内容
- **5.** 提供社区成员用于**代码分享、技术交流、的论坛和群组**
37 changes: 37 additions & 0 deletions book/src/d2ds/chapter_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# 创建文档仓库

使用模板仓库创建新的文档仓库步骤

## 1.使用模板仓库

- 点击[xlings-book-template](https://github.com/d2learn/xlings-book-template)右上角`Use this template`, 在自己的账号下创建新的仓库, 或者直接点击[此连接](https://github.com/new?template_name=xlings-book-template&template_owner=d2learn)

-`Repository name`中填写新仓库的名字

- 填写描述(可选)

- 点击`Create repository`创建

## 2.开启仓库github-pages

**在创建的新仓库页面**

- `Settings`设置
- 点击左侧`Pages`
- `Build and deployment`
- `Branch` 中选择分支(一般为`main` - `/(root)`)
- 点击`save`保存

> 注: 点击保存后, 大概几分钟**在线书籍/笔记/文档**就能部署好
## 3.访问在线书籍

> 访问部署的文档
```bash
# https://d2learn.github.io/xlings-book-template/
https://username.github.io/repo-name
```

- **username:** 为你的账号名
- **repo-name:** 为新建的仓库名
27 changes: 27 additions & 0 deletions book/src/xlings/chapter_0.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# xlings简介

一个自动化编译运行检测、教程教学类项目构建和管理工具

## 功能

- **项目模板** - 快速生成一个包括书籍、练习代码等内容的项目结构
- **自动化练习检测** - 编译器驱动开发学习
- **Markdown书籍** - 编写markdown文件生成在线电子书
- **常用工具下载** - 常用技术类工具/软件下载
- **多语言代码运行检测** - 自动识别代码文件进行(编译)运行, 并时实检测代码变化显示运行结果
- c
- cpp
- python
- ...
- **多项目管理和下载** - 多个项目管理、信息查看、下载等功能
- **AI提示引导** - 配置对应的大模型, 做为错误代码提示小助理
- openai - dev
- tongyi - ok
- ...

## 使用场景

- 个人编程学习
- 文档、书籍编写
- 环境配置和软件安装
- 课程教学、实验搭建
34 changes: 34 additions & 0 deletions book/src/xlings/chapter_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 快速安装

## 方式一: 命令行安装

**使用git获取源码**

```bash
git clone [email protected]:d2learn/xlings.git
```

**安装xlings**

> 在项目的根目录执行安装脚本
**linux/macos**

```bash
bash tools/install.unix.sh
```

**windows**

```bash
tools\install.win.bat
```

## 方式二: 下载zip包安装

**下载压缩包** -> [xlings.zip](https://github.com/d2learn/xlings/archive/refs/heads/main.zip)

**解压zip并运行安装脚本**

- windows: 双击解压后 tools目录中的`install.win.bat`进行安装
- linux: 鼠标右键点击 tools目录中的`install.unix.sh`选择**运行程序选项**进行安装
22 changes: 22 additions & 0 deletions book/src/xlings/chapter_2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## 常用命令功能

```bash
xlings version: pre-v0.0.1

Usage: $ xlings [command] [target]

Commands:
run, easy to run target - sourcecode file
install, install software/env(target)
drepo, print drepo info or download drepo(target)
update, update xlings to the latest version
uninstall, uninstall xlings
help, help info

Project Commands: (need config.xlings)
init, init project by config.xlings
book, open project's book in default browser
checker, start project's auto-exercises from target

repo: https://github.com/d2learn/xlings
```
75 changes: 75 additions & 0 deletions book/src/xlings/chapter_2_3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# 项目管理 - drepo

## 查看所有项目信息

```bash
xlings drepo
```

**输出示例**

```bash
drepo lists

--- d2python ---
git : [email protected]:d2learn/d2python.git
url : https://github.com/d2learn/d2python
name : d2python
tags : python
profile : 动手学d2python项目
--- d2x ---
git : [email protected]:d2learn/xlings.git
url : https://github.com/d2learn
name : d2x
tags : template
profile : drepo的模板配置文件
--- xlings ---
git : [email protected]:d2learn/xlings.git
url : https://github.com/d2learn/xlings
name : xlings
tags : tools, build, auto-exercises, pkg-manager
profile : 技术、实验、练习、自学类项目, 快速构建和管理工具
--- d2ds ---
git : [email protected]:d2learn/d2ds.git
url : https://github.com/d2learn/d2ds
name : d2ds
tags : c++, data-structures
profile : 强调动手实践的数据结构学习项目,其中包含在线书籍、公开课、练习代码等子项目
--- d2cpp ---
git : [email protected]:d2learn/d2cpp.git
url : https://github.com/d2learn/d2cpp
name : d2cpp
tags : c++
profile : 动手学C++项目

run xlings drepo [drepo_name] to download
```

## 项目下载和使用

> 以下载[d2ds](https://github.com/Sunrisepeak/d2ds)并运行dslings练习代码为例
### 下载项目

下载d2ds项目到当前目录

```bash
xlings drepo d2ds
```

### 安装目标项目依赖

在下载项目的根目录运行命令安装该项目的依赖

```bash
cd d2ds
xlings install
```

### 运行项目练习

运行d2ds项目中的dslings代码练习

```bash
xlings dslings
```
1 change: 1 addition & 0 deletions book/src/xlings/chapter_3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# 3.项目搭建
34 changes: 34 additions & 0 deletions book/src/xlings/chapter_3_1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 快速使用

使用xlings快速创建一个项目(以clings为例)

## 项目配置

在一个空目录中新建一个config.xlings文件, 填写描述项目的基础信息

```lua
xlings_name = "clings" -- 项目名
xlings_lang = "c" -- 项目中使用的编程语言
```

## 生成项目结构

在config.xlings同目录执行项目初始化

```bash
xlings init
```

## 运行自动练习检测

使用`xlings [项目名]`开启自动练习检测

```bash
xlings clings # clings 是配置文件中配置的项目名
```


```bash
xlings checker
```

0 comments on commit b1b2853

Please sign in to comment.