Skip to content

Commit

Permalink
Update README.md (#78)
Browse files Browse the repository at this point in the history
- Break up a comma splice
- Add link to https://en.wikipedia.org/wiki/Literate_programming
- Move the VS Code screenshot to be under the corresponding list item
- Use [semantic line breaks](https://rhodesmill.org/brandon/2012/one-sentence-per-line/) to improve readability of diffs and the markdown source
- Remove two excess blank lines which make no difference in the rendered HTML output
  • Loading branch information
waldyrious authored Mar 23, 2023
1 parent 3e0efdf commit b1a2eb6
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,32 @@
[![Go Report Card](https://goreportcard.com/badge/github.com/joerdav/xc)](https://goreportcard.com/report/github.com/joerdav/xc)
[![Coverage Status](https://coveralls.io/repos/github/joerdav/xc/badge.svg?branch=main)](https://coveralls.io/github/joerdav/xc?branch=main)


</div>


`xc` is a task runner similar to `Make` or `npm run`, that aims to be more discoverable and approachable.

The problem `xc` is intended to solve is scripts maintained separately from their documentation.
Often a `Makefile` or a `package.json` will contain some useful scripts for developing on a project, then the `README.md` will surface and describe these scripts.
Since the documentation is separate it may not be updated when scripts are changed or added, `xc` aims to solve this by defining the scripts inline with the documentation.
Often a `Makefile` or a `package.json` will contain some useful scripts for developing on a project,
then the `README.md` will surface and describe these scripts.
In such a case, since the documentation is separate, it may not be updated when scripts are changed or added.
`xc` aims to solve this by defining the scripts [inline with the documentation](https://en.wikipedia.org/wiki/Literate_programming).

`xc` is designed to maximise convenience, and minimise complexity.
Each `xc` task is defined in simple, human-readable Markdown.
This means that even people without the `xc` tool installed can use the README.md (or whatever Markdown file contains the tasks) as a source of useful commands for the project.
This means that even people without the `xc` tool installed can use the README.md
(or whatever Markdown file contains the tasks)
as a source of useful commands for the project.

# Installation

Installation instructions are described at <https://xcfile.dev/getting-started/#installation>.

# Features

![vscode demo](https://user-images.githubusercontent.com/19927761/214538057-963f9a47-ff95-486c-8856-b90bd358be3f.png)

- Tasks defined in Markdown files as code blocks.
- Editor tools:
- Editor integration:
- VSCode (list and run `xc` tasks)
![vscode demo](https://user-images.githubusercontent.com/19927761/214538057-963f9a47-ff95-486c-8856-b90bd358be3f.png)
- Vim (recommended config for listing and running `xc` tasks)

# Example
Expand Down

0 comments on commit b1a2eb6

Please sign in to comment.