anon/contra
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

minor README fixes

Browse Source
This commit is contained in:
anon 2023-11-15 21:20:09 +01:00
parent a7cc85f43b
commit d7be7b6a6a
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -2,18 +2,19 @@
> The Contra utility converts so called the "C Style Markup Language" to HTML/XML and back.
> The primary aim is to maximize both editability and readability by dynamizing the markup representation.
The Contra utility itself is meant to serve as a backbone other tools,
The Contra utility itself is meant to serve as a backbone for other tools,
such as text editor or IDE extensions.
For a complete explanation see documentation/specification.md.
See `documentation/*` for the exact details or follow this README for a quick-start.
### Gallery
### Example
// TODO
### Installantion
For any of the below plugins to work,
the Contra executable will have to be installed on your system.
##### Build from source
Contra is written in C,
it must be compiled.
@ -27,12 +28,13 @@ After navigating to the root directory, run:
```Bash
$ make
```
This will result in a new file called `contra`,
place it in your $PATH.
This will result in a new executable file called `contra`,
place it in your `$PATH`.
The easiest way to do so is by running:
```Bash
$ make install
```
#### Vim
Place the file "plugin/contra.vim" inside "~/.vim/plugin/".
You might have to create the directory yourself.
@ -42,6 +44,7 @@ you could run:
```
$ make vim_install
```
#### Visual Studio Code
The VS Code extension is written in TypeScript,
so it has to be compiled too.