/Xjtuse-Guide

Xjtuse-Guide

Primary LanguageJavaScriptMIT LicenseMIT

XJTUSE-GUIDE

西安交通大学软件学院学习指南

!> 目前该项目处于起步阶段，非常希望大家可以一起帮助完善内容，做成软工同学们一个交流学习的平台

为什么发起这个项目

首先不得不提的一点是开源精神！！！

起初只是我和易俊泉学长把自己的笔记放在 CSDN 上让学弟学妹们参考，这种算是比较简单快捷的方式，但是由于 CSDN 并不是定制的笔记网站，因此相对来说内容会很乱，导致找资料什么的都不方便，泉佬也将自己的笔记开源到了 Github 上，但是并没有制作一个阅读的网站，只能是 clone 后在本地看，也不是很方便。

我在 CSDN 发博客时候就在考虑要不要自己做个笔记网站来分享一些笔记内容，但是由于当时各种事情太忙加上我也比较懒，一直搁置到现在，最近中期答辩完了闲下来，然后慢慢开始准备这个项目，同时也是找到了一些学弟学妹也有相同的想法，希望将自己为考试准备的一些东西分享出来，毕业后就没有什么作用了，不如帮助学弟学妹们学习更简单一些，节省出一些时间去做自己想做的事情，同时避免一些重复劳动。

---- by 霍嘉

这个项目有什么

这个项目中主要包含有三个部分:

  1. 对于所有课程的介绍，包括课内笔记，复习笔记，备考经验等
  2. 毕业去向交流，包含四个模块：考研、保研、工作、出国，有对应的经验帖做介绍
  3. 分流&转专业，主要是学长学姐们介绍自己为什么选择软件工程专业以及转专业的一些经验
  4. 学长学姐有话说，主要是对于自己大学生活的一个回顾总结，以及对于学弟学妹们的一些建议

怎样使用这个项目

本项目已部署到 Github Pages，可以在线浏览

也可以将本项目拉取到本地运行，本项目使用 docsify 编译，因此本地需有 nodejs 环境，建议下载 LTS 版本，下载后全局安装 docsify 依赖，然后运行即可。

git clone https://github.com/Hydrion-Qlz/XJTUSE-GUIDE.git
cd xjtuse-guide
npm i docsify-cli -g
docsify serve .

Feature

通过集成 docsify 多样化的插件，文档支持 Latex 公式， pdf文件渲染

如何参与贡献该项目

该项目由西安交通大学软件学院同学维护

  • 如果你在阅读时候发现文档内容或者格式有问题，可以在仓库提 issue 或者修改后提 pr
  • 如果添加新的文件，请尽可能在所有可能引用该文件的地方加入引入，确保侧边栏显示正确
  • 如果你不懂如何自己提交，可提 issue 留下自己的联系方式，会有维护同学联系你进行文件上传
  • commit规范可以通过安装vscode插件git-commit-plugin来实现

提交细节请参考How to Contribute

如果是软工的同学，建议还是自己搞懂如何提 pr、如何使用 Github，算是一种必须掌握的技能

友群链接

  • 西交软件保研交流群（qq）：63606491
    • 仅提供给西交软工专业的同学交流保研经验，入群验证请提供年级、学号和姓名。

todo