Skip to content

Commit f77bc05

Browse files
author
Innes Anderson-Morrison
committed
chore: updating README and adding github CI / issue templates
1 parent c041332 commit f77bc05

File tree

5 files changed

+142
-0
lines changed

5 files changed

+142
-0
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Describe the bug
11+
12+
...
13+
14+
### To Reproduce
15+
16+
Steps to reproduce the behavior:
17+
18+
### Expected behavior
19+
20+
...
21+
22+
### Screenshots
23+
24+
If applicable, add screenshots to help explain your problem.
25+
26+
### Versions & OS Details
27+
28+
- OS: [e.g. linux/bsd]
29+
- Distribution [e.g. Ubuntu/Arch]
30+
- OS Version [e.g. 20.04 LTS]
31+
- ad Version [point version from crates.io or hash of develop]
32+
33+
### Additional context
34+

‎.github/ISSUE_TEMPLATE/feature_request.md

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
### Please describe the change / addition you'd like to see made
11+
12+
- Is this completely new functionality, or an enhancement to existing functionality?
13+
- What kind of feature is it that you are requesting?
14+
15+
16+
### Is this a feature you have seen in other text editors?
17+
18+
If so, please provide any links or reference to the existing implementation
19+
and some details on how the feature is used.

‎.github/ISSUE_TEMPLATE/question.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Question
3+
about: Ask a question about how ad works
4+
title: 'Question: ...'
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
### Before raising an issue...
11+
12+
There are a number of resources available that might already have the answer you're after!
13+
Please make sure you have checked them before raising a new issue:
14+
- [Existing GitHub issues](https://github.com/sminez/ad/issues)
15+
- [docs.rs docs](https://docs.rs/ad-editor)
16+
17+
If what you are after isn't in there then ask away!

‎.github/workflows/rust.yml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Build
2+
3+
on:
4+
push:
5+
branches:
6+
- develop
7+
pull_request:
8+
branches:
9+
- develop
10+
11+
env:
12+
CARGO_TERM_COLOR: always
13+
RUST_LOG: info
14+
RUST_BACKTRACE: 1
15+
16+
jobs:
17+
test:
18+
name: Test Rust ${{ matrix.rust }}
19+
runs-on: ubuntu-latest
20+
strategy:
21+
fail-fast: false
22+
matrix:
23+
rust: [stable, beta, nightly]
24+
features: ["default", "default,serde"]
25+
26+
steps:
27+
- uses: actions/checkout@v2
28+
- uses: hecrj/setup-rust-action@v1
29+
with:
30+
rust-version: ${{ matrix.rust }}
31+
32+
- name: Run tests
33+
run: cargo test --workspace --features ${{ matrix.features }} --verbose
34+
35+
rustfmt:
36+
name: Ensure rustfmt is happy
37+
runs-on: ubuntu-latest
38+
steps:
39+
- uses: actions/checkout@v2
40+
- uses: hecrj/setup-rust-action@v1
41+
with:
42+
components: rustfmt
43+
- run: cargo fmt --all -- --check
44+
45+
clippy:
46+
name: Lint the codebase with clippy
47+
runs-on: ubuntu-latest
48+
# env:
49+
# RUSTFLAGS: -Dwarnings
50+
steps:
51+
- uses: actions/checkout@v2
52+
- uses: hecrj/setup-rust-action@v1
53+
with:
54+
components: clippy
55+
- uses: actions-rs/clippy-check@v1
56+
with:
57+
token: ${{ secrets.GITHUB_TOKEN }}
58+
args: --workspace --all-targets --all-features --examples --tests
59+
60+
rustdoc-links:
61+
name: Check doc links are valid
62+
runs-on: ubuntu-latest
63+
64+
steps:
65+
- uses: actions/checkout@v2
66+
- uses: hecrj/setup-rust-action@v1
67+
with:
68+
rust-version: nightly
69+
- run: cargo rustdoc --all-features

‎README.md

+3
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ad :: an adaptable text editor
22

3+
[![Build](https://github.com/sminez/ad/workflows/Build/badge.svg?branch=develop)](https://github.com/sminez/ad/actions?query=workflow%3ABuild) [![crates.io version](https://img.shields.io/crates/v/ad-editor)](https://crates.io/crates/ad-editor) [![docs.rs](https://img.shields.io/docsrs/ad-editor?logo=rust)](https://docs.rs/ad-editor)
4+
35
`ad` (pronounced A.D.) is an attempt at combining a modal editing interface of likes of `vi`
46
and `kakoune` with the approach to extensibility of Plan9's `Acme`. It is primarily intended
57
as playground for experimenting with implementing various text editor features and currently
@@ -37,6 +39,7 @@ _This is a non-exhaustive list of some of the more interesting parts of the inte
3739
- **exec**: minimal implementation of the core of the [sam editing language](http://doc.cat-v.org/bell_labs/sam_lang_tutorial/sam_tut.pdf)
3840
- **fsys**: virtual filesystem interface to the editor state in the style of [acme](http://acme.cat-v.org/)
3941
- **ninep**: [9p protocol](http://9p.cat-v.org/) implementation that backs the fsys module
42+
- Now moved out to its own crate with source code available [here](https://github.com/sminez/ninep).
4043
- **regex**: custom regex engine that is able to work on character streams. This is nowhere near as performant as
4144
the [regex crate](https://github.com/rust-lang/regex) (obviously) but it allows for some flexability in tinkering
4245
with the exec command language.

0 commit comments

Comments
 (0)