chore: updating README and adding github CI / issue templates

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+### Describe the bug
+
+...
+
+### To Reproduce
+
+Steps to reproduce the behavior:
+
+### Expected behavior
+
+...
+
+### Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+### Versions & OS Details
+
+- OS: [e.g. linux/bsd]
+- Distribution [e.g. Ubuntu/Arch]
+- OS Version [e.g. 20.04 LTS]
+- ad Version [point version from crates.io or hash of develop]
+
+### Additional context
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+### Please describe the change / addition you'd like to see made
+
+- Is this completely new functionality, or an enhancement to existing functionality?
+- What kind of feature is it that you are requesting?
+
+
+### Is this a feature you have seen in other text editors?
+
+If so, please provide any links or reference to the existing implementation
+and some details on how the feature is used.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,17 @@
+---
+name: Question
+about: Ask a question about how ad works
+title: 'Question: ...'
+labels: question
+assignees: ''
+
+---
+
+### Before raising an issue...
+
+There are a number of resources available that might already have the answer you're after!
+Please make sure you have checked them before raising a new issue:
+  - [Existing GitHub issues](https://github.com/sminez/ad/issues)
+  - [docs.rs docs](https://docs.rs/ad-editor)
+
+If what you are after isn't in there then ask away!

.github/workflows/rust.yml

@@ -0,0 +1,69 @@
+name: Build
+
+on:
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
+
+env:
+  CARGO_TERM_COLOR: always
+  RUST_LOG: info
+  RUST_BACKTRACE: 1
+
+jobs:
+  test:
+    name: Test Rust ${{ matrix.rust }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        rust: [stable, beta, nightly]
+        features: ["default", "default,serde"]
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: hecrj/setup-rust-action@v1
+      with:
+        rust-version: ${{ matrix.rust }}
+
+    - name: Run tests
+      run: cargo test --workspace --features ${{ matrix.features }} --verbose
+
+  rustfmt:
+    name: Ensure rustfmt is happy
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: hecrj/setup-rust-action@v1
+      with:
+        components: rustfmt
+    - run: cargo fmt --all -- --check
+
+  clippy:
+    name: Lint the codebase with clippy
+    runs-on: ubuntu-latest
+    # env:
+    #   RUSTFLAGS: -Dwarnings
+    steps:
+    - uses: actions/checkout@v2
+    - uses: hecrj/setup-rust-action@v1
+      with:
+        components: clippy
+    - uses: actions-rs/clippy-check@v1
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        args: --workspace --all-targets --all-features --examples --tests
+
+  rustdoc-links:
+    name: Check doc links are valid
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: hecrj/setup-rust-action@v1
+      with:
+        rust-version: nightly
+    - run: cargo rustdoc --all-features

README.md

@@ -1,5 +1,7 @@
 # ad :: an adaptable text editor
 
+[![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)
+
 `ad` (pronounced A.D.) is an attempt at combining a modal editing interface of likes of `vi`
 and `kakoune` with the approach to extensibility of Plan9's `Acme`. It is primarily intended
 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
 - **exec**: minimal implementation of the core of the [sam editing language](http://doc.cat-v.org/bell_labs/sam_lang_tutorial/sam_tut.pdf)
 - **fsys**: virtual filesystem interface to the editor state in the style of [acme](http://acme.cat-v.org/)
 - **ninep**: [9p protocol](http://9p.cat-v.org/) implementation that backs the fsys module
+  - Now moved out to its own crate with source code available [here](https://github.com/sminez/ninep).
 - **regex**: custom regex engine that is able to work on character streams. This is nowhere near as performant as
   the [regex crate](https://github.com/rust-lang/regex) (obviously) but it allows for some flexability in tinkering
   with the exec command language.