Awesome-Linux-Software/auto_sort/README.md

51 lines
2.1 KiB
Markdown
Raw Normal View History

- [English](#introduction)
- [中文](#介绍)
# Introduction
2016-08-25 13:23:20 +02:00
`asort.py` is a very simple python3 script that aims to make sure items in the README file of the repo [Awesome-Linux-Software](https://github.com/VoLuong/Awesome-Linux-Software) are sorted alphabetically.
This script only sorts items in the following topics for now (items between topic Applications and topic Setup):
- Applications
- Command Line Utilities
- Desktop Environments
- Display Managers
- Window Managers
# Usage
1. Add items to corresponding topics, don't worry about the order of those items.
1. Make sure you've installed python3 environment on your system.
2016-08-24 15:36:45 +02:00
1. Open a terminal, type `python3 asort.py` to run this script. After that, you'll get a new README file with all the items in the above topics sorted alphabetically.
2016-08-22 08:29:41 +02:00
![test screenshot](./test.png)
## Note
`asort_zh.py` works for the file [README_zh-CN.md](https://github.com/VoLuong/Awesome-Linux-Software/blob/master/README_zh-CN.md), the Chinese version of this list.
# License
MIT License.
---------------------------------------------
# 介绍
2016-08-25 13:23:20 +02:00
`asort.py` 是一个非常简单的 python3 脚本,它负责将 [Awesome-Linux-Software](https://github.com/VoLuong/Awesome-Linux-Software) 仓库的 README.md 文件中的条目按照字母表顺序排列,以方便查阅。
该脚本只会为如下几个主题中的条目进行排序(实际上就是在主题 *应用程序**配置* 之间的所有条目):
- 应用程序
- 命令行实用工具
- 桌面环境
- 显示管理器
- 窗口管理器
# 用法
1. 请首先按照说明将新的条目添加到合适的主题下,不用考虑排序问题;
1. 然后,确保你在系统上安装了 Python3 运行环境;
1. 打开终端,运行 `python3 asort.py` 即可。之后,你将得到一个新生成的 README 文件,并且文件中所有的在上述几个主题中的条目都已经按照字母表的顺序排列好了。
![test 截图](./test.png)
## 注意
新增的 `asort_zh.py` 专门用于中文版 [README_zh-CN.md](https://github.com/VoLuong/Awesome-Linux-Software/blob/master/README_zh-CN.md) 条目排序。用法与上面类似。
# 许可
MIT 许可协议。