美文网首页OneOS物联网操作系统
最适合学习的轻量操作系统,代码与文档的有效结合

最适合学习的轻量操作系统,代码与文档的有效结合

作者: 罗蓁蓁 | 来源:发表于2021-10-28 18:01 被阅读0次

1.OneOS-Lite网址

OneOS-Lite文档网站:https://oneos-lite.com/

OneOS-Lite仓库地址:https://gitee.com/cmcc-oneos/OneOS-Lite

OneOS-Lite版本处于迭代中,欢迎开发者提出宝贵意见,也希望点击右上角,一键三连(forkstarfollow)。

值得说明的是,OneOS-Lite的文档与代码仓库是紧密连接在一起的,处于同一仓库之中。对于喜欢物联网操作系统,希望自学入门的童鞋们来说,非常有益。

2.文档在线浏览

访问OneOS-Lite网站:https://oneos-lite.com/

image

访问OneOS官方网站:OneOS - 中国移动物联网操作系统 (10086.cn)

image

3.文档本地浏览

该文档和代码放在同一个仓库,开发者在下载代码的同时,已一并下载文档。我们认为,结合文档查阅代码,是更高效的开发方式。相关源码目录均放有和代码相关的文档说明。

image

开发者可以使用我们提供的OneOS-Cube工具,启动一个本地服务器,可以方便地实时预览效果。在代码根目录输入如下命令:

python -m http.server 3000

结果如下:

PS D:\xiaoneng\oneos-2.0> python -m http.server 3000
Serving HTTP on :: port 3000 (http://[::]:3000/) ...
::1 - - [21/Jul/2021 14:45:24] "GET / HTTP/1.1" 200 -

则可以访问地址:http://localhost:3000 ,阅读文档。

如果你的电脑有安装python3,可以进入该仓库,在命令行中执行命令:

python -m http.server 3000

如果你的电脑有安装npm,可以通过运行 docsify serve 启动一个本地服务器。默认访问地址 http://localhost:3000

docsify serve oneos-2.0

在此之前,需要使用npm或者yarn安装docsify-cli

npm i docsify-cli -g
# yarn global add docsify-cli

4.文档编辑

该文档和代码均开源部署到gitee仓库,若发现文档错误,可至文档左上角,点击Edit Document,进行编辑并提交merge

image

点击Edit Document后,会进入到gitee编辑页面,点击编辑

image

提交信息处注明:文档修改点,如文档错误/增加/删除/更新:×××。若有更多的修改思路,可添加至扩展信息。最后,选中提交的目标分支,点击提交,即可。

image

5.关注&&联系

gitee: https://gitee.com/cmcc-oneos/OneOS-Lite

docs: https://oneos-lite.com/

相关文章

  • 最适合学习的轻量操作系统,代码与文档的有效结合

    1.OneOS-Lite网址 OneOS-Lite文档网站:https://oneos-lite.com/[htt...

  • 484.【Unix/Linux】文档标准

    如果你必须手动记录文档,我们的经验表明,维护文档最简单,也是最有效的方式就是简洁、轻量的文档作为标准。不用为组织编...

  • Swift 学习笔记

    大纲 学习线路主要分为UIKit、Foundation、网络请求三大路线; 结合文档梳理笔记,github托管代码...

  • OpenCV-Python 系列教程绪论

    1. 教程说明 OpenCV 学习教程,结合 OpenCV 原始文档和《OpenCV 编程入门》一书,所有代码经过...

  • springboot2(1)-Swagger2集成

    Swagger2 的作用 随项目自动生成强大RESTfulAPI文档,减少工作量API文档与代码整合在一起,便于同...

  • hw-final 注意事项 2021-07-02

    大作业要达成的教学目标先有文档,后有代码,良好的文档相当重要。学习他人的代码,包括框架与编码细节。更快更准地找到想...

  • 自我提升计划

    * Spring文档学习 * junit的源代码学习

  • web.xml配置详解

    1. XML文档有效性检查 这段代码指定文件类型定义(DTD),可以通过它检查XML文档的有效性。下面显示的

  • Swagger UI初识

    新项目使用Swagger UI自动生成接口文档,不需要频繁更新接口文档,保证接口文档与代码的一致,值得学习。本文记...

  • 12.5敏捷软件开发

    敏捷 agile,原本的意思是麻雀展翼的动作,曾用名light-weight。以前区分轻量与重量的区别在于文档的数...

网友评论

    本文标题:最适合学习的轻量操作系统,代码与文档的有效结合

    本文链接:https://www.haomeiwen.com/subject/bmivaltx.html